https://api.veriko.mx/v1/insights/overview User's KPI summary
How-to guide →Returns the user's key indicators: total validations, today's and yesterday's counts, success rate, and average latency over the last 24 hours. Includes the Banxico verdict distribution for the last 7 days.
curl -X GET 'https://api.veriko.mx/v1/insights/overview' \
-H 'Authorization: Bearer mxcep_••••'
Python example — coming soon.
JavaScript example — coming soon.
PHP example — coming soon.
| Field | Type | Description |
|---|---|---|
total | integer | Total validations in the selected scope and period. |
today | integer | Validations created on the current calendar day (UTC). |
yesterday | integer | Validations created on the previous calendar day (UTC). |
success_rate | number | Percentage of validations with `valid` verdict out of all completed, expressed from 0 to 100. |
avg_latency_ms | integer | Average processing time in milliseconds over the last 24 hours. |
by_banxico_7d | object | Banxico verdict distribution for the last 7 days. Keys are verdict enum values (`valid`, `not_found`, `cep_unavailable`, `error`). Missing values imply zero. |
scope | string | Overview scope: `self` — only the authenticated user's validations; `global` — all platform validations (admin only). |
| Status | Class | Description | Body |
|---|---|---|---|
| 200 | 2xx | User-scoped KPIs and Banxico verdict distribution for the last 7 days. | No body |
| 401 | 4xx | Authentication is required or the provided credentials are invalid. | ErrorResponse |
| 403 | 4xx | Permisos insuficientes | ErrorResponse |
| Status | Code | Detail |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|