मुख्य सामग्री पर जाएं
GET
curl
यह endpoint एनालिटिक्स डैशबोर्ड के पीछे के आँकड़े लौटाता है, जो Business Console में दिखते हैं। इसके दो रिस्पॉन्स फ़ॉर्मेट हैं: हर विजेट में kind और title होते हैं; उसके बाकी फ़ील्ड kind पर निर्भर करते हैं। available_widget_keys पढ़ने के लिए एक बार scope को बिना widget_keys के भेजें, फिर केवल उन्हीं विजेट का अनुरोध करें जिनकी आपको ज़रूरत है।
इस endpoint को केवल पूर्ण-एक्सेस API कुंजी ही कॉल कर सकती है। स्कोप्ड कुंजी को, उसके पास चाहे जो भी एक्सेस हो, 403 मिलता है, और किसी दूसरे एप्लिकेशन की कुंजी को भी यही मिलता है। देखें API कुंजियाँ।

संबंधित

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और 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>

विजेट वापस करने के लिए डैशबोर्ड टैब (केस-असंवेदनशील)। KYC सारांश के लिए इसे widget_keys के साथ छोड़ दें। केवल widget_keys भेजना kyc को दर्शाता है। home किसी भी KYC, KYB या लेन-देन विजेट को स्वीकार करता है और एप्लिकेशन के सहेजे गए होम लेआउट पर डिफ़ॉल्ट होता है।

उपलब्ध विकल्प:
home,
kyc,
kyb,
transactions
widget_keys
string

अल्पविराम से अलग की गई विजेट कुंजियाँ, इसी क्रम में उत्तर दी गई हैं। जो कुंजियाँ स्कोप द्वारा स्वीकार नहीं की जाती हैं उन्हें छोड़ दिया जाता है; जब कोई शेष नहीं बचता है तो आपको स्कोप के डिफ़ॉल्ट मिलते हैं। 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

अल्पविराम से अलग किए गए वर्कफ़्लो ID। KYC सारांश और KYC एवं KYB विजेट को उन वर्कफ़्लो तक सीमित करता है। जो मान UUID नहीं हैं उन्हें अनदेखा कर दिया जाता है; जब कोई भी मान्य नहीं होता है तो फ़िल्टर हटा दिया जाता है। सारांश workflow_id को भी स्वीकार करता है।

उदाहरण:

"33333333-4444-5555-6666-777777777777"

versions
string

अल्पविराम से अलग किए गए वर्कफ़्लो संस्करण संख्याएँ। केवल workflow_ids के साथ लागू होता है; जो मान पूर्ण संख्या नहीं हैं उन्हें अनदेखा कर दिया जाता है। version को उपनाम के रूप में स्वीकार किया जाता है।

उदाहरण:

"3,4"

branch_path_ids
string

कॉमा से अलग की गई शाखा पाथ ID। केवल 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
आवश्यक

वर्कफ़्लो ID द्वारा कुंजीबद्ध। 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 सूचियों को कैसे समूहीकृत किया जाता है: 14 दिनों तक के लिए day, 90 दिनों तक week, उसके बाद 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[]
आवश्यक
अंतिम संशोधन 7 नवंबर 2026