الانتقال إلى المحتوى الرئيسي
GET
Python
يوفّر Reports API غير المتزامن من Didit مهمة تصدير وقائمة الإخفاقات الحالية لها. يساوي 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>
مطلوب

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

report_uuid
string<uuid>
مطلوب

معرّف UUID للتقرير.

الاستجابة

استرجع تقريراً غير متزامن.

uuid
string<uuid>
مطلوب

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

report_type
enum<string>
مطلوب

نوع التصدير أو تقرير الامتثال.

الخيارات المتاحة:
SESSION_EXPORT,
TRANSACTION_EXPORT,
BUSINESS_EXPORT,
VENDOR_USER_EXPORT,
VENDOR_BUSINESS_EXPORT,
CASE_EXPORT,
CASE_SLA_EXPORT,
LIST_ENTRY_EXPORT,
EVENT_EXPORT,
COMPLIANCE_KYC_KYB,
COMPLIANCE_AML_LOG,
COMPLIANCE_TRAVEL_RULE,
COMPLIANCE_SANCTIONS_PEP,
COMPLIANCE_RISK_SUMMARY,
COMPLIANCE_SAR_STR_DRAFT,
COMPLIANCE_CTR,
COMPLIANCE_CASE_SUMMARY
report_type_display
string
مطلوب

عنوان العرض لنوع التقرير.

status
enum<string>
مطلوب

حالة التوليد. قد تتضمن الحالة READY حالات فشل فردية؛ تحقّق من failed_count.

الخيارات المتاحة:
PENDING,
PROCESSING,
READY,
FAILED
status_display
string
مطلوب

عنوان العرض لحالة التوليد.

parameters
object
مطلوب

خيارات التصدير الأصلية؛ تختلف المفاتيح حسب report_type.

requested_by_user_id
string<uuid> | null
مطلوب

هوية الطالب الأصلي، أو null للمتصلين الذين لا يملكون هوية مستخدم.

requested_by_email
string | null
مطلوب

البريد الإلكتروني للطالب، عند توفره.

requested_by_name
string | null
مطلوب

اسم عرض الطالب، عند توفره.

row_count
integer | null
مطلوب

عدد السجلات المصدّرة، أو null قبل إنشاء التقرير.

failed_item_ids
string<uuid>[]
مطلوب

معرّفات UUID للجلسات المباشرة التي فشلت في تصدير التحقق هذا. تُستبعد الجلسات المحذوفة. استخدم هذه المعرّفات لإعادة المحاولة الانتقائية.

failed_count
integer
مطلوب

عدد العناصر في failed_item_ids.

النطاق المطلوب: x >= 0
file_size
integer<int64> | null
مطلوب

إجمالي حجم الملف المُنشأ بالبايت، أو null قبل الإنشاء.

files
object[]
مطلوب

البيانات الوصفية للملف المُولَّد؛ ولا تحتوي على روابط تنزيل.

scheduled_report
string<uuid> | null
مطلوب

معرّف الجدولة، أو null للتقرير غير المجدول.

error_message
string | null
مطلوب

خطأ التوليد، عند توفره.

deletion_pending
boolean
مطلوب

ما إذا كان الحذف المطلوب ما زال قيد التنفيذ.

eta_seconds
integer | null
مطلوب

الوقت المقدّر بالثواني حتى الاكتمال لتقرير قيد الانتظار أو المعالجة؛ تكون القيمة null في غياب السجل أو عند الاكتمال.

started_at
string<date-time> | null
مطلوب

وقت بدء التوليد.

completed_at
string<date-time> | null
مطلوب

وقت اكتمال التوليد.

expires_at
string<date-time>
مطلوب

وقت انتهاء صلاحية التقرير.

created_at
string<date-time>
مطلوب

وقت الإنشاء.

updated_at
string<date-time>
مطلوب

وقت آخر تحديث.

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