الانتقال إلى المحتوى الرئيسي
GET
curl
تُرجع نقطة النهاية الأرقام التي تقف وراء لوحة التحليلات في Business Console. وتعيد شكلين من الاستجابة: يحمل كل أداة من أدوات لوحة المعلومات الحقلين kind وtitle، أما بقية حقولها فتعتمد على نوعها. أرسل scope دون widget_keys مرة واحدة لقراءة available_widget_keys، ثم اطلب الأدوات التي تحتاجها فقط.
لا يمكن استدعاء نقطة النهاية هذه إلا بمفتاح API يملك صلاحية كاملة. يتلقى المفتاح المقيّد النطاق الاستجابة 403 مهما كانت صلاحياته، وكذلك مفتاح يعود إلى تطبيق آخر. راجع مفاتيح API.

ذات صلة

التفويضات

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>
مطلوب

UUID الخاص بالمؤسسة.

application_id
string<uuid>
مطلوب

معرّف UUID للتطبيق. يجب أن يكون التطبيق الذي ينتمي إليه مفتاح API: أي مفتاح يُستخدم مع تطبيق آخر يتلقى الرمز 403.

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

start_date
string<date>

اليوم الأول من النطاق، YYYY-MM-DD، شاملاً ذلك اليوم (UTC). أرسله مع end_date: إذا كان أحدهما مفقوداً، فسيتم تجاهل كليهما ويمتد النطاق من 30 يوماً قبل اليوم وحتى اليوم.

مثال:

"2026-10-01"

end_date
string<date>

آخر يوم في النطاق، بصيغة YYYY-MM-DD، شامل (بتوقيت UTC). يُحتسب أي تاريخ مستقبلي على أنه اليوم. لا يجوز أن يتجاوز النطاق 730 يوماً.

مثال:

"2026-10-15"

scope
enum<string>

علامة تبويب لوحة التحكم المراد إرجاع التطبيقات المصغرة (widgets) لها (غير حساسة لحالة الأحرف). اتركها، مع widget_keys، للحصول على ملخص KYC. إرسال widget_keys فقط يعني ضمناً kyc. تقبل home أي تطبيق مصغر لـ KYC أو KYB أو المعاملات، وتعتمد افتراضياً تخطيط الصفحة الرئيسية المحفوظ للتطبيق.

الخيارات المتاحة:
home,
kyc,
kyb,
transactions
widget_keys
string

مفاتيح عناصر واجهة المستخدم (widgets) مفصولة بفواصل، وتتم الإجابة عليها بهذا الترتيب. يتم استبعاد المفاتيح التي لا يقبلها النطاق؛ وعند عدم تبقي أي منها، ستحصل على القيم الافتراضية للنطاق. KYC: kyc_sessions_volume، kyc_warning_insights، kyc_id_locations، kyc_ip_locations، kyc_workflow_funnel، kyc_average_verification_time، kyc_conversion_rate، kyc_conversion_by_country، kyc_resubmission_insights، kyc_original_status_distribution، kyc_database_validation_coverage، kyc_database_validation_latency، kyc_demographics، kyc_device_details. KYB: kyb_sessions_volume، kyb_workflow_funnel، kyb_average_verification_time، kyb_ip_locations، kyb_business_country_distribution، kyb_warning_insights، kyb_conversion_rate، kyb_conversion_by_country، kyb_industry_breakdown، kyb_resubmission_insights، kyb_original_status_distribution، kyb_registry_coverage، kyb_registry_data_completeness، kyb_device_details. المعاملات: tx_count_total، tx_count_daily، tx_volume_total_preferred_currency، tx_volume_daily_preferred_currency، tx_average_amount، tx_average_amount_daily، tx_transaction_category_breakdown، tx_action_type_breakdown، tx_status_volume_trend، tx_user_ip_or_country_distribution، tx_tag_breakdown، tx_top_rules_triggered، tx_team_member_performance، tx_score_histogram.

مثال:

"tx_count_total,tx_count_daily"

workflow_ids
string

معرّفات سير العمل مفصولة بفواصل. تقيّد ملخص KYC وعناصر واجهة مستخدم KYC وKYB بسير العمل المحدد فقط. يتم تجاهل القيم التي ليست بصيغة UUID؛ وعندما لا تكون أي قيمة صالحة، يتم إلغاء التصفية. يقبل الملخص أيضاً workflow_id.

مثال:

"33333333-4444-5555-6666-777777777777"

versions
string

أرقام إصدارات سير العمل مفصولة بفواصل. لا تنطبق إلا بالاقتران مع workflow_ids؛ ويتم تجاهل القيم التي ليست أرقاماً صحيحة. يُقبل version كاسم بديل.

مثال:

"3,4"

branch_path_ids
string

معرّفات مسارات الفروع مفصولة بفواصل. تنطبق فقط مع workflow_ids، وفقط على مقاييس KYC. تُسجَّل المقاييس حالياً فقط لـ default (جميع المسارات مجتمعة)، لذا فإن أي قيمة أخرى تُرجع مقاييس فارغة. يُقبل branch_path_id كاسم بديل.

مثال:

"default"

tag
string

عناصر واجهة المعاملات فقط: معرّفات UUID للوسوم أو أسماء الوسوم مفصولة بفواصل.

transaction_type
string

عناصر واجهة المعاملات فقط: فئات المعاملات مفصولة بفواصل.

مثال:

"finance"

action_type
string

عناصر واجهة المعاملات فقط: أنواع الإجراءات مفصولة بفواصل (غير حساسة لحالة الأحرف).

مثال:

"withdrawal"

الاستجابة

ملخص KYC، أو التطبيقات المصغّرة المطلوبة عند إرسال scope أو widget_keys.

ملخص التحقق من المستخدمين (KYC)، يتم إرجاعه عندما لا يتم إرسال scope ولا widget_keys.

data_points
object[]
مطلوب

نقطة واحدة لكل يوم، من اليوم الأول الذي يتضمن جلسات ضمن النطاق حتى end_date. تكون يومية دائماً، بصرف النظر عن قيمة grouping_mode.

request_breakdown
object
مطلوب

إجماليات الحالة للنطاق المحدد. يحتوي تفصيل الفترة السابقة على الحقول المطلوبة على الأقل.

previous_data_points
object[]
مطلوب

النقاط اليومية للفترة ذات الطول نفسه السابقة مباشرة لـ start_date.

previous_request_breakdown
object
مطلوب

إجماليات الحالة للنطاق المحدد. يحتوي تفصيل الفترة السابقة على الحقول المطلوبة على الأقل.

conversion_rate
number | null
مطلوب

total_approved / (total_approved + total_declined + total_in_review) x 100، بمنزلة عشرية واحدة. null عند عدم اكتمال أي شيء.

location_stats
object
مطلوب
demographic_stats
object
مطلوب
device_details
object
مطلوب

أعلى خمسة من كل منها، مع بدء الجلسات الأكثر أولاً.

workflow_funnel_stats
object
مطلوب

مفهرس حسب معرّف سير العمل. يمثل total الجلسات التي بدأت في سير العمل هذا؛ بينما يحسب steps الجلسات التي وصلت إلى كل خطوة (OCR وLIVENESS وFACE_MATCH وAML وPOA وPHONE وEMAIL وNFC وDATABASE_VALIDATION وQUESTIONNAIRE وIP_ANALYSIS وAGE_ESTIMATION وKYB_REGISTRY وKYB_DOCUMENTS وKYB_KEY_PEOPLE). الوصول إلى الخطوة لا يعني اجتيازها.

verification_time_stats
object
مطلوب

الوقت الفعلي الذي قضاه المستخدمون في التحقق، مع تجاهل فترات الخمول. كائن فارغ في حال عدم وجود بيانات.

resubmission_stats
object
مطلوب
warning_stats
object
مطلوب

مفهرس حسب الميزة (ID_VERIFICATION وLIVENESS وFACEMATCH وAML وPROOF_OF_ADDRESS وPHONE وEMAIL وNFC وLOCATION وDATABASE_VALIDATION وQUESTIONNAIRE وميزات KYB). يمثل total الجلسات التي وصلت إلى الميزة؛ بينما يحسب risks الجلسات لكل رمز تحذير ومستوى.

original_status_stats
object
مطلوب

القرار التلقائي لسير العمل، قبل أن يغيّره أي مراجِع.

grouping_mode
enum<string>
مطلوب

كيفية تجميع قوائم *_time_series: day لما يصل إلى 14 يوماً، وweek لما يصل إلى 90 يوماً، وmonth لما يزيد عن ذلك. تُقاس بدءاً من اليوم الأول الذي يحتوي على جلسات ضمن النطاق.

الخيارات المتاحة:
day,
week,
month
demographic_time_series
object[]
مطلوب
device_time_series
object[]
مطلوب
verification_time_time_series
object[]
مطلوب
resubmission_time_series
object[]
مطلوب
original_status_time_series
object[]
مطلوب
آخر تعديل في ٧ نوفمبر ٢٠٢٦