https://api.veriko.mx/v1/insights/overview Resumen de KPIs del usuario
Guía de uso →Devuelve los indicadores clave del usuario: total de validaciones, consumo de hoy y ayer, tasa de éxito y latencia promedio de las últimas 24 horas. Incluye la distribución de veredictos Banxico de los últimos 7 días.
curl -X GET 'https://api.veriko.mx/v1/insights/overview' \
-H 'Authorization: Bearer mxcep_••••'
Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
total | integer | Total de validaciones en el alcance y periodo seleccionado. |
today | integer | Validaciones creadas en el día calendario actual (UTC). |
yesterday | integer | Validaciones creadas en el día calendario anterior (UTC). |
success_rate | number | Porcentaje de validaciones con veredicto `valid` sobre el total completado, expresado de 0 a 100. |
avg_latency_ms | integer | Tiempo promedio de procesamiento en milisegundos de las últimas 24 horas. |
by_banxico_7d | object | Distribución de veredictos Banxico de los últimos 7 días. Las claves son valores del enum de veredicto (`valid`, `not_found`, `cep_unavailable`, `error`). Los valores ausentes implican cero. |
scope | string | Alcance del overview: `self` — solo las validaciones del usuario autenticado; `global` — todas las validaciones de la plataforma (solo para administradores). |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | KPIs propios del usuario y distribución de veredictos de los últimos 7 días. | Sin cuerpo |
| 401 | 4xx | Se requiere autenticación o las credenciales son inválidas | ErrorResponse |
| 403 | 4xx | Permisos insuficientes | ErrorResponse |
| Código | Clave | Detalle |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|