← Back to schema index

InsightsOverviewAttributes

Validation overview KPIs. Available in self (`self`) and platform-wide (`global`) scope. Returned by `GET /v1/insights/overview`.

Properties

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).

Used in operations

  • GET /v1/insights/overview
  • GET /v1/admin/insights/overview