Zum Hauptinhalt springen
GET
curl
Der Endpoint liefert die Daten für das Analytics-Dashboard der Business Console. Er hat zwei Antwortformen: Jedes Widget enthält ein kind und einen title; die übrigen Felder hängen von der Art des Widgets ab. Senden Sie scope einmal ohne widget_keys, um available_widget_keys abzufragen, und fordern Sie dann nur die Widgets an, die Sie benötigen.
Nur ein API-Schlüssel mit vollem Zugriff kann diesen Endpoint aufrufen. Ein eingeschränkter Schlüssel erhält unabhängig von seinen Berechtigungen 403, ebenso ein Schlüssel einer anderen Anwendung. Siehe API-Schlüssel.

Verwandte Themen

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Pfadparameter

organization_id
string<uuid>
erforderlich

UUID der Organisation.

application_id
string<uuid>
erforderlich

Anwendungs-UUID. Muss die Anwendung sein, zu der der API-Schlüssel gehört: Ein für eine andere Anwendung verwendeter Schlüssel erhält 403.

Abfrageparameter

start_date
string<date>

Erster Tag des Zeitraums, YYYY-MM-DD, einschließlich (UTC). Zusammen mit end_date senden: Wenn einer von beiden fehlt, werden beide ignoriert und der Zeitraum reicht von 30 Tagen vor heute bis heute.

Beispiel:

"2026-10-01"

end_date
string<date>

Letzter Tag des Zeitraums, YYYY-MM-DD, einschließlich (UTC). Ein Datum in der Zukunft zählt als heute. Der Zeitraum darf 730 Tage nicht überschreiten.

Beispiel:

"2026-10-15"

scope
enum<string>

Dashboard-Tab, für den Widgets zurückgegeben werden sollen (Groß-/Kleinschreibung wird nicht beachtet). Lassen Sie ihn zusammen mit widget_keys weg, um die KYC-Zusammenfassung zu erhalten. Das Senden von nur widget_keys impliziert kyc. home akzeptiert jedes KYC-, KYB- oder Transaktions-Widget und verwendet standardmäßig das gespeicherte Start-Layout der Anwendung.

Verfügbare Optionen:
home,
kyc,
kyb,
transactions
widget_keys
string

Kommagetrennte Widget-Schlüssel, in dieser Reihenfolge zurückgegeben. Schlüssel, die der Scope nicht akzeptiert, werden verworfen; wenn keine übrig bleiben, erhalten Sie die Standardwerte des Scopes. 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. Transaktionen: 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.

Beispiel:

"tx_count_total,tx_count_daily"

workflow_ids
string

Kommagetrennte Workflow-IDs. Beschränkt die KYC-Zusammenfassung sowie die KYC- und KYB-Widgets auf diese Workflows. Werte, die keine UUIDs sind, werden ignoriert; wenn keiner gültig ist, wird der Filter verworfen. Die Zusammenfassung akzeptiert auch workflow_id.

Beispiel:

"33333333-4444-5555-6666-777777777777"

versions
string

Kommagetrennte Workflow-Versionsnummern. Gilt nur zusammen mit workflow_ids; Werte, die keine ganzen Zahlen sind, werden ignoriert. version wird als Alias akzeptiert.

Beispiel:

"3,4"

branch_path_ids
string

Kommagetrennte Verzweigungspfad-IDs. Gilt nur zusammen mit workflow_ids und nur für KYC-Zahlen. Zahlen werden derzeit nur für default (alle Pfade kombiniert) erfasst, sodass jeder andere Wert leere Zahlen zurückgibt. branch_path_id wird als Alias akzeptiert.

Beispiel:

"default"

tag
string

Nur Transaktions-Widgets: kommagetrennte Tag-UUIDs oder Tag-Namen.

transaction_type
string

Nur Transaktions-Widgets: kommagetrennte Transaktionskategorien.

Beispiel:

"finance"

action_type
string

Nur Transaktions-Widgets: kommagetrennte Aktionstypen (Groß-/Kleinschreibung wird nicht berücksichtigt).

Beispiel:

"withdrawal"

Antwort

Die KYC-Zusammenfassung oder die angeforderten Widgets, wenn scope oder widget_keys gesendet wird.

Zusammenfassung der Benutzerverifizierung (KYC), die zurückgegeben wird, wenn weder scope noch widget_keys gesendet werden.

data_points
object[]
erforderlich

Ein Datenpunkt pro Tag, vom ersten Tag mit Sitzungen im Zeitraum bis end_date. Immer täglich, unabhängig vom Wert für grouping_mode.

request_breakdown
object
erforderlich

Statussummen für den Zeitraum. Die Aufschlüsselung des vorherigen Zeitraums enthält mindestens die erforderlichen Felder.

previous_data_points
object[]
erforderlich

Tägliche Datenpunkte für den Zeitraum derselben Länge direkt vor start_date.

previous_request_breakdown
object
erforderlich

Statussummen für den Zeitraum. Die Aufschlüsselung des vorherigen Zeitraums enthält mindestens die erforderlichen Felder.

conversion_rate
number | null
erforderlich

total_approved / (total_approved + total_declined + total_in_review) x 100, eine Nachkommastelle. null, wenn noch nichts abgeschlossen wurde.

location_stats
object
erforderlich
demographic_stats
object
erforderlich
device_details
object
erforderlich

Die fünf häufigsten jedes Typs, die meisten Sitzungen zuerst.

workflow_funnel_stats
object
erforderlich

Nach Workflow-ID gegliedert. total gibt die in diesem Workflow gestarteten Sitzungen an; steps zählt die Sitzungen, die den jeweiligen Schritt erreicht haben (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Das Erreichen eines Schritts bedeutet nicht, dass er erfolgreich bestanden wurde.

verification_time_stats
object
erforderlich

Aktive Zeit, die Benutzer mit der Verifizierung verbracht haben, Leerlaufzeiten ausgenommen. Ein leeres Objekt, wenn keine Daten vorliegen.

resubmission_stats
object
erforderlich
warning_stats
object
erforderlich

Nach Funktion gegliedert (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE und die KYB-Funktionen). total gibt die Sitzungen an, die die Funktion erreicht haben; risks zählt Sitzungen pro Warnungscode und Stufe.

original_status_stats
object
erforderlich

Die automatische Entscheidung des Workflows, bevor ein Prüfer sie geändert hat.

grouping_mode
enum<string>
erforderlich

Wie die *_time_series-Listen gruppiert sind: day für bis zu 14 Tage, week bis zu 90, month darüber hinaus. Gemessen ab dem ersten Tag mit Sitzungen im Bereich.

Verfügbare Optionen:
day,
week,
month
demographic_time_series
object[]
erforderlich
device_time_series
object[]
erforderlich
verification_time_time_series
object[]
erforderlich
resubmission_time_series
object[]
erforderlich
original_status_time_series
object[]
erforderlich
Zuletzt geändert am 7. November 2026