User's KPI summary

GEThttps://api.veriko.mx/v1/insights/overview

User's KPI summary

Returns the user's key indicators:

Includes the Banxico verdict distribution for the last 7 days.

Request

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/insights/overview' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`InsightsOverviewAttributes` — User-scoped KPIs and Banxico verdict distribution for the last 7 days.
Field	Type	Description
`total`	`integer`	Total validations in the selected scope and period. e.g. `1240`
`today`	`integer`	Validations created on the current calendar day (UTC). e.g. `37`
`yesterday`	`integer`	Validations created on the previous calendar day (UTC). e.g. `42`
`success_rate`	`number`	Percentage of validations with `valid` verdict out of all completed, expressed from 0 to 100. e.g. `94.2`
`avg_latency_ms`	`integer`	Average processing time in milliseconds over the last 24 hours. e.g. `810`
`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. e.g. `{"valid":210,"invalid":8,"not_found":3,"cep_unavailable":2}`
`scope`	`string`	Overview scope: `self` — only the authenticated user's validations; `global` — all platform validations (admin only). e.g. `self`

**Response status codes**`GET /v1/insights/overview`
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`	Insufficient permissions.	`ErrorResponse`

**Errors from `GET /v1/insights/overview`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b9`
403	`forbidden`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c0`