Saltar al contenido principal
GET
curl
El endpoint devuelve las cifras que hay detrás del panel de analíticas de la Business Console. Tiene dos formas de respuesta: Cada widget incluye un kind y un title; el resto de sus campos depende del tipo. Envía scope sin widget_keys una vez para leer available_widget_keys y, después, solicita solo los widgets que necesites.
Solo una clave de API con acceso completo puede invocar este endpoint. Una clave con acceso limitado recibe 403 independientemente de los permisos que tenga, y lo mismo ocurre con una clave de otra aplicación. Consulta claves de API.

Contenido relacionado

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de ruta

organization_id
string<uuid>
requerido

UUID de la organización.

application_id
string<uuid>
requerido

UUID de la aplicación. Debe ser la aplicación a la que pertenece la clave de API: una clave usada en cualquier otra aplicación recibe 403.

Parámetros de consulta

start_date
string<date>

Primer día del rango, YYYY-MM-DD, inclusive (UTC). Envíalo junto con end_date: si falta cualquiera de los dos, se ignoran ambos y el rango va desde 30 días antes de hoy hasta hoy.

Ejemplo:

"2026-10-01"

end_date
string<date>

Último día del rango, YYYY-MM-DD, inclusive (UTC). Una fecha futura cuenta como hoy. El rango no puede superar los 730 días.

Ejemplo:

"2026-10-15"

scope
enum<string>

Pestaña del panel cuyos widgets se devuelven (no distingue mayúsculas de minúsculas). Omítela, junto con widget_keys, para obtener el resumen de KYC. Enviar solo widget_keys implica kyc. home acepta cualquier widget de KYC, KYB o transacciones y, por defecto, usa el diseño de inicio guardado de la aplicación.

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

Claves de widgets separadas por comas, que se devuelven en este orden. Las claves que el ámbito no acepta se descartan; si no queda ninguna, recibes los valores predeterminados del ámbito. 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. Transacciones: 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.

Ejemplo:

"tx_count_total,tx_count_daily"

workflow_ids
string

IDs de flujos separados por comas. Limita el resumen de KYC y los widgets de KYC y KYB a esos flujos. Los valores que no son UUID se ignoran; si ninguno es válido, se descarta el filtro. El resumen también acepta workflow_id.

Ejemplo:

"33333333-4444-5555-6666-777777777777"

versions
string

Números de versión de flujo separados por comas. Solo se aplica junto con workflow_ids; los valores que no son números enteros se ignoran. También se acepta version como alias.

Ejemplo:

"3,4"

branch_path_ids
string

IDs de rutas de rama separados por comas. Solo se aplica junto con workflow_ids y solo a las cifras de KYC. Actualmente las cifras solo se registran para default (todas las rutas combinadas), por lo que cualquier otro valor devuelve cifras vacías. Se acepta branch_path_id como alias.

Ejemplo:

"default"

tag
string

Solo widgets de transacciones: UUID o nombres de etiquetas separados por comas.

transaction_type
string

Solo widgets de transacciones: categorías de transacción separadas por comas.

Ejemplo:

"finance"

action_type
string

Solo widgets de transacciones: tipos de acción separados por comas (sin distinguir mayúsculas de minúsculas).

Ejemplo:

"withdrawal"

Respuesta

El resumen de KYC, o los widgets solicitados cuando se envía scope o widget_keys.

Resumen de verificación de usuarios (KYC), que se devuelve cuando no se envía ni scope ni widget_keys.

data_points
object[]
requerido

Un punto por día, desde el primer día con sesiones dentro del rango hasta end_date. Siempre diario, independientemente de lo que indique grouping_mode.

request_breakdown
object
requerido

Totales por estado para el rango. El desglose del período anterior incluye al menos los campos obligatorios.

previous_data_points
object[]
requerido

Puntos diarios del período de la misma duración inmediatamente anterior a start_date.

previous_request_breakdown
object
requerido

Totales por estado para el rango. El desglose del período anterior incluye al menos los campos obligatorios.

conversion_rate
number | null
requerido

total_approved / (total_approved + total_declined + total_in_review) x 100, con un decimal. null cuando no ha finalizado nada.

location_stats
object
requerido
demographic_stats
object
requerido
device_details
object
requerido

Los cinco primeros de cada uno, ordenados de más a menos sesiones.

workflow_funnel_stats
object
requerido

Indexado por ID de flujo. total son las sesiones iniciadas en ese flujo; steps cuenta las sesiones que llegaron a cada paso (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Llegar a un paso no significa superarlo.

verification_time_stats
object
requerido

Tiempo activo que los usuarios dedicaron a verificarse, sin contar los periodos de inactividad. Un objeto vacío cuando no hay datos.

resubmission_stats
object
requerido
warning_stats
object
requerido

Indexado por función (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE y las funciones KYB). total son las sesiones que llegaron a la función; risks cuenta las sesiones por código y nivel de advertencia.

original_status_stats
object
requerido

El veredicto automático del flujo, antes de que un revisor lo cambiara.

grouping_mode
enum<string>
requerido

Cómo se agrupan las listas *_time_series: day hasta 14 días, week hasta 90 y month a partir de ahí. Se mide desde el primer día con sesiones en el rango.

Opciones disponibles:
day,
week,
month
demographic_time_series
object[]
requerido
device_time_series
object[]
requerido
verification_time_time_series
object[]
requerido
resubmission_time_series
object[]
requerido
original_status_time_series
object[]
requerido
Última modificación el 1 de noviembre de 2026