التوثيق

GET /v1/usage

كل طلب يمرّ بمفتاحك مُسجَّل — وهذه النقطة تقرأ ذلك السجل نفسه لك. الإجماليات، توزيع المسارات، فئات الأخطاء، نسب زمن الاستجابة وتفصيل التغطية تُحسب حيًّا من RequestLog وتطابق عدّ SQL مباشر حرفيًا. ثلاث نوافذ (24 ساعة / 7 أيام / 30 يومًا) لمفتاحك أنت فقط — لا مفتاح آخر ولا مستأجر آخر.

GET /v1/usage api-key #

اقرأ عدّاد استهلاكك بنفسك — المفتاح يرى صفوف RequestLog الخاصة به وحسب. يردّ حالة الحصة وثلاث نوافذ (24 ساعة/7 أيام/30 يومًا): إجماليات، عدّ لكل مسار، فئات أخطاء متمايزة، نسب زمن استجابة وحصيلة التغطية. لا حاجة للوحة: الأرقام هي الـAPI.

مثال

curl -X GET https://agw.orcanox.xyz/v1/usage \
  -H "Authorization: Bearer agw_…"

الاستجابة

json
{
  "key": {
    "name": "default",
    "scopes": [
      "read",
      "search"
    ],
    "createdAt": "2026-10-01T09: 00: 00.000Z"
  },
  "quota": {
    "limit": 10000,
    "used": 1234,
    "remaining": 8766,
    "resetsAt": "2026-11-01T00: 00: 00.000Z"
  },
  "windows": [
    {
      "range": "24h",
      "total": 40,
      "byEndpoint": {
        "search": 20,
        "read": 12,
        "research": 8
      },
      "errors": {
        "402": 0,
        "429": 1,
        "4xx": 2,
        "5xx": 0
      },
      "latencyMs": {
        "avg": 340,
        "p50": 210,
        "p95": 980,
        "max": 1500
      },
      "coverage": {
        "official": 15,
        "bestEffort": 5
      }
    }
  ],
  "generatedAt": "2026-10-05T12: 00: 00.000Z"
}