Saltar al contingut principal
GET
curl
L’endpoint retorna les dades que hi ha darrere del tauler d’analítica de la Business Console. Té dues formes de resposta: Cada giny té un kind i un title; la resta de camps depenen del kind. Envia scope sense widget_keys una vegada per llegir available_widget_keys, i després sol·licita només els widgets que necessites.
Només una clau d’API amb accés complet pot cridar aquest endpoint. Una clau amb àmbit restringit rep 403 independentment de l’accés que tingui, i una clau d’una altra aplicació també rep aquest error. Consulta Claus d’API.

Relacionats

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

organization_id
string<uuid>
requerit

UUID de l'organització.

application_id
string<uuid>
requerit

UUID de l'aplicació. Ha de ser l'aplicació a la qual pertany la clau d'API: una clau utilitzada en qualsevol altra aplicació rep un 403.

Paràmetres de consulta

start_date
string<date>

Primer dia de l'interval, YYYY-MM-DD, inclusiu (UTC). Envia'l juntament amb end_date: quan en falta algun, s'ignoren tots dos i l'interval abasta des de 30 dies abans d'avui fins a avui.

Exemple:

"2026-10-01"

end_date
string<date>

Últim dia de l'interval, YYYY-MM-DD, inclusiu (UTC). Una data futura compta com avui. L'interval no pot superar els 730 dies.

Exemple:

"2026-10-15"

scope
enum<string>

Pestanya del tauler de la qual es retornaran els ginys (no distingeix entre majúscules i minúscules). Omet-la, juntament amb widget_keys, per obtenir el resum de KYC. Enviar només widget_keys implica kyc. home accepta qualsevol giny de KYC, KYB o de transaccions i s'estableix per defecte en el disseny d'inici desat de l'aplicació.

Opcions disponibles:
home,
kyc,
kyb,
transactions
widget_keys
string

Claus de widgets separades per comes, retornades en aquest ordre. S'ometen les claus que l'abast no admet; si no en queda cap, obtens els valors per defecte de l'abast. 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. Transaccions: 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.

Exemple:

"tx_count_total,tx_count_daily"

workflow_ids
string

ID de flux de treball separats per comes. Limita el resum de KYC i els widgets de KYC i KYB a aquests fluxos de treball. Els valors que no siguin UUID s'ignoren; si cap no és vàlid, es descarta el filtre. El resum també accepta workflow_id.

Exemple:

"33333333-4444-5555-6666-777777777777"

versions
string

Números de versió del flux de treball separats per comes. Només s'aplica juntament amb workflow_ids; els valors que no siguin números enters s'ignoren. S'accepta version com a àlies.

Exemple:

"3,4"

branch_path_ids
string

Identificadors de camí de branca separats per comes. S'aplica només juntament amb workflow_ids, i només a les xifres de KYC. Actualment, les xifres només es registren per a default (tots els camins combinats), de manera que qualsevol altre valor retorna xifres buides. S'accepta branch_path_id com a àlies.

Exemple:

"default"

tag
string

Només ginys de transaccions: UUIDs d'etiquetes o noms d'etiquetes separats per comes.

transaction_type
string

Només ginys de transaccions: categories de transacció separades per comes.

Exemple:

"finance"

action_type
string

Només ginys de transaccions: tipus d'acció separats per comes (sense distinció entre majúscules i minúscules).

Exemple:

"withdrawal"

Resposta

El resum de KYC, o els ginys sol·licitats quan s'envia scope o widget_keys.

Resum de la verificació d'usuaris (KYC), retornat quan no s'envia ni scope ni widget_keys.

data_points
object[]
requerit

Un punt per dia, des del primer dia amb sessions a l'interval fins a end_date. Sempre diari, independentment del que indiqui grouping_mode.

request_breakdown
object
requerit

Totals d'estat per a l'interval. El desglossament del període anterior conté com a mínim els camps obligatoris.

previous_data_points
object[]
requerit

Punts diaris per al període de la mateixa durada just abans de start_date.

previous_request_breakdown
object
requerit

Totals d'estat per a l'interval. El desglossament del període anterior conté com a mínim els camps obligatoris.

conversion_rate
number | null
requerit

total_approved / (total_approved + total_declined + total_in_review) x 100, un decimal. null quan no s'ha finalitzat res.

location_stats
object
requerit
demographic_stats
object
requerit
device_details
object
requerit

Els cinc primers de cadascun, amb més sessions primer.

workflow_funnel_stats
object
requerit

Indexat per ID de flux de treball. total és el nombre de sessions iniciades en aquest flux de treball; steps compta les sessions que han arribat a cada pas (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Arribar a un pas no equival a superar-lo.

verification_time_stats
object
requerit

Temps actiu que els usuaris han passat verificant, ignorant els intervals d'inactivitat. És un objecte buit quan no hi ha dades.

resubmission_stats
object
requerit
warning_stats
object
requerit

Indexat per funcionalitat (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE i les funcionalitats de KYB). total és el nombre de sessions que han arribat a la funcionalitat; risks compta les sessions per codi d'advertència i nivell.

original_status_stats
object
requerit

El veredicte automàtic del flux de treball, abans que cap revisor el modifiqués.

grouping_mode
enum<string>
requerit

Com s'agrupen les llistes de *_time_series: day per a períodes de fins a 14 dies, week per a períodes de fins a 90 dies i month per a períodes superiors. Es mesura a partir del primer dia amb sessions dins l'interval.

Opcions disponibles:
day,
week,
month
demographic_time_series
object[]
requerit
device_time_series
object[]
requerit
verification_time_time_series
object[]
requerit
resubmission_time_series
object[]
requerit
original_status_time_series
object[]
requerit
Darrera modificació el 7 de novembre del 2026