Vai al contenuto principale
GET
curl
L’endpoint restituisce i dati alla base della dashboard di analisi della Business Console. Ha due formati di risposta: Ogni widget contiene un kind e un title; gli altri campi dipendono dal tipo. Invia scope senza widget_keys una volta per leggere available_widget_keys, poi richiedi solo i widget di cui hai bisogno.
Solo una chiave API con accesso completo può chiamare questo endpoint. Una chiave con ambito limitato riceve 403 indipendentemente dalle autorizzazioni di cui dispone, e lo stesso vale per una chiave di un’altra applicazione. Vedi Chiavi API.

Correlati

Autorizzazioni

x-api-key
string
header
obbligatorio

La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys.

Parametri del percorso

organization_id
string<uuid>
obbligatorio

UUID dell'organizzazione.

application_id
string<uuid>
obbligatorio

UUID dell'applicazione. Deve essere l'applicazione a cui appartiene la chiave API: una chiave utilizzata su qualsiasi altra applicazione riceve 403.

Parametri della query

start_date
string<date>

Primo giorno dell'intervallo, YYYY-MM-DD, incluso (UTC). Da inviare insieme a end_date: se uno dei due manca, entrambi vengono ignorati e l'intervallo copre dai 30 giorni precedenti a oggi fino a oggi.

Esempio:

"2026-10-01"

end_date
string<date>

Ultimo giorno dell'intervallo, YYYY-MM-DD, incluso (UTC). Una data futura viene considerata come oggi. L'intervallo non può superare 730 giorni.

Esempio:

"2026-10-15"

scope
enum<string>

Scheda della dashboard per cui restituire i widget (senza distinzione tra maiuscole e minuscole). Omettila, insieme a widget_keys, per il riepilogo KYC. L'invio del solo widget_keys implica kyc. home accetta qualsiasi widget KYC, KYB o delle transazioni e usa come impostazione predefinita il layout della schermata iniziale salvato dell'applicazione.

Opzioni disponibili:
home,
kyc,
kyb,
transactions
widget_keys
string

Chiavi dei widget separate da virgola, restituite in questo ordine. Le chiavi non accettate dall'ambito vengono scartate; se non ne rimane nessuna, vengono utilizzati i valori predefiniti dell'ambito. 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. Transazioni: 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.

Esempio:

"tx_count_total,tx_count_daily"

workflow_ids
string

ID dei workflow separati da virgola. Limita il riepilogo KYC e i widget KYC e KYB a tali workflow. I valori che non sono UUID vengono ignorati; se nessuno è valido, il filtro viene ignorato. Il riepilogo accetta anche workflow_id.

Esempio:

"33333333-4444-5555-6666-777777777777"

versions
string

Numeri di versione dei workflow separati da virgola. Si applica solo insieme a workflow_ids; i valori che non sono numeri interi vengono ignorati. version è accettato come alias.

Esempio:

"3,4"

branch_path_ids
string

ID dei percorsi dei rami separati da virgole. Si applica solo insieme a workflow_ids e solo ai dati KYC. I dati sono attualmente registrati solo per default (tutti i percorsi combinati), quindi qualsiasi altro valore restituisce dati vuoti. branch_path_id è accettato come alias.

Esempio:

"default"

tag
string

Solo widget delle transazioni: UUID dei tag o nomi dei tag separati da virgole.

transaction_type
string

Solo widget delle transazioni: categorie di transazione separate da virgole.

Esempio:

"finance"

action_type
string

Solo widget delle transazioni: tipi di azione separati da virgole (senza distinzione tra maiuscole e minuscole).

Esempio:

"withdrawal"

Risposta

Il riepilogo KYC, oppure i widget richiesti quando viene inviato scope o widget_keys.

Riepilogo della verifica degli utenti (KYC), restituito quando non vengono inviati né scope né widget_keys.

data_points
object[]
obbligatorio

Un punto al giorno, dal primo giorno con sessioni nell'intervallo fino a end_date. Sempre giornaliero, indipendentemente dal valore di grouping_mode.

request_breakdown
object
obbligatorio

Totali degli stati per l'intervallo. La suddivisione del periodo precedente contiene almeno i campi obbligatori.

previous_data_points
object[]
obbligatorio

Punti giornalieri per il periodo della stessa durata immediatamente precedente a start_date.

previous_request_breakdown
object
obbligatorio

Totali degli stati per l'intervallo. La suddivisione del periodo precedente contiene almeno i campi obbligatori.

conversion_rate
number | null
obbligatorio

total_approved / (total_approved + total_declined + total_in_review) x 100, con un decimale. null se nessuna operazione è terminata.

location_stats
object
obbligatorio
demographic_stats
object
obbligatorio
device_details
object
obbligatorio

I primi cinque per ciascuno, ordinati per numero decrescente di sessioni.

workflow_funnel_stats
object
obbligatorio

Indicizzato per ID del workflow. total indica le sessioni avviate su quel workflow; steps conta le sessioni che hanno raggiunto ciascun passaggio (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Il raggiungimento di un passaggio non equivale al suo superamento.

verification_time_stats
object
obbligatorio

Tempo attivo trascorso dagli utenti durante la verifica, ignorando i periodi di inattività. Un oggetto vuoto in assenza di dati.

resubmission_stats
object
obbligatorio
warning_stats
object
obbligatorio

Indicizzato per funzionalità (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE e le funzionalità KYB). total indica le sessioni che hanno raggiunto la funzionalità; risks conta le sessioni per codice e livello di avviso.

original_status_stats
object
obbligatorio

Il verdetto automatico del workflow, prima che qualsiasi revisore lo modificasse.

grouping_mode
enum<string>
obbligatorio

In che modo sono raggruppati gli elenchi *_time_series: day fino a 14 giorni, week fino a 90, month oltre. Misurato a partire dal primo giorno con sessioni nell'intervallo.

Opzioni disponibili:
day,
week,
month
demographic_time_series
object[]
obbligatorio
device_time_series
object[]
obbligatorio
verification_time_time_series
object[]
obbligatorio
resubmission_time_series
object[]
obbligatorio
original_status_time_series
object[]
obbligatorio
Ultima modifica il 7 novembre 2026