الانتقال إلى المحتوى الرئيسي
GET
Python
Didit’s Reports API غير المتزامنة تعرض مهام التصدير التي يمكنك قراءتها، من الأحدث إلى الأقدم. استخدم failed_count وfailed_item_ids لتحديد عمليات تصدير التحقق التي تتضمن إخفاقات فردية. يمكنك الاطلاع على إرشادات التصدير وإعادة المحاولة، أو استرجاع تقرير واحد، أو إعادة محاولة تصدير.

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

organization_id
string<uuid>
مطلوب

معرّف المؤسسة.

application_id
string<uuid>
مطلوب

معرّف التطبيق.

معلمات الاستعلام

limit
integer
افتراضي:50

الحد الأقصى لعدد النتائج في كل صفحة.

النطاق المطلوب: x >= 1
offset
integer
افتراضي:0

عدد النتائج التي يجب تخطيها.

النطاق المطلوب: x >= 0
status
string

قيم status مفصولة بفواصل أو مكررة: PENDING، وPROCESSING، وREADY، وFAILED.

report_type
string

قيم report_type مفصولة بفواصل أو مكررة.

q
string

ابحث بجزء من معرّف التقرير أو باسم مقدّم الطلب أو بريده الإلكتروني (255 حرفاً كحد أقصى).

الاستجابة

سرد التقارير غير المتزامنة.

count
integer
مطلوب

عدد النتائج، ويُقتصر عادةً على 100، وقد يكون تقديرياً. اتبع next بدلاً من استخدام count لإيقاف الترقيم.

next
string | null
مطلوب

عنوان URL للصفحة التالية، أو null.

previous
string | null
مطلوب

عنوان URL للصفحة السابقة، أو null.

results
object[]
مطلوب
counts
object
مطلوب

عدد جميع التقارير التي يمكن للمستدعي قراءتها، قبل تطبيق تصفية القائمة.

آخر تعديل في ١٤ نوفمبر ٢٠٢٦