عرض الأحداث

المعاملات

Lingara-Versionheaderstringاختياري

إصدار API الذي يُجاب عن هذا الطلب به. بدونه، يحصل رمز الوصول على الإصدار الذي رُبط به عميله، ويحصل الطلب الذي لا رمز مميز فيه على الإصدار الحالي. لا يمكن الوصول إلى الإصدار الذي لا يزال قيد التطوير إلا بذكره هنا. الإصدار غير المعروف يُجاب عنه بـ 400 مع الرمز api_version_unknown. يسرد GET /v1/versions الإصدارات.

cursorquerystringاختياري

من أين تتابع: next_cursor لصفحة سابقة، أو id: لحدث في البث. المؤشر الأقدم من 30 يومًا يُجاب بـ 410 مع الرمز cursor_expired.

startquerystringاختياري

من أين تبدأ دون مؤشر: latest للأحداث من الآن فصاعدًا، أو oldest لكل حدث لا يزال محفوظًا.

typesqueryarray of stringاختياري

هذه الأنواع من الأحداث فقط، مفصولة بفواصل. من دونه، كل نوع تستطيع نطاقات رمزك قراءته.

limitqueryintegerاختياري

أقصى عدد من الأحداث تعيده صفحة واحدة، من 1 إلى 100.

الاستجابات

200 صفحة من الأحداث والمؤشر الذي تتابع منه

itemsarray of EventEnvelopeمطلوب

idstringمطلوب

typestringمطلوب

created_atstringمطلوب

api_versionstringمطلوب

subjectstringمطلوب

dataobjectمطلوب

next_cursorstringمطلوب

has_morebooleanمطلوب

الأخطاء

410application/json

api_version_discontinued: توقف إصدار واجهة البرمجة الخاص بهذا الطلب. cursor_expired: المؤشر أقدم من 30 يومًا؛ ابدأ من جديد دون مؤشر.

4XXapplication/json

رُفض الطلب. يوضّح code السبب، ويشرحه error بالكلمات.

503application/json · text/plain

الخدمة غير متاحة مؤقتًا؛ أعد المحاولة بعد عدد الثواني المذكور في Retry-After. أثناء الصيانة يكون المتن نصًا عاديًا بدلًا من غلاف الخطأ.

5XXapplication/json

رُفض الطلب. يوضّح code السبب، ويشرحه error بالكلمات.

codestringمطلوب

سبب رفض الطلب، في صورة رمز ثابت يمكن التفرّع بناءً عليه: مثل insufficient_scope (403) وrate_limited (429)، ولعميل يُفوتَر بحسب الاستهلاك spend_cap_reached (402) وmetered_billing_inactive (402).

errorstringمطلوب

مثال

curl "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

تفضّل مكتبة؟ راجع قسم المكتبات.