https://api.veriko.mx/v1/validations/stats Estadísticas de verificaciones del usuario
Guía de uso →Devuelve contadores agregados de las verificaciones del usuario autenticado: total, valid, not_found, cep_unavailable, error, pending, deleted y other, más un desglose by_type (direct/ocr) y un desglose by_status por estado de ciclo de vida (queued/processing/valid/…). El cubo other es el resto tras restar los cinco estados nombrados (en la práctica, filas invalid). Los cubos de primer nivel cuentan por banxico_status (veredicto); by_status cuenta por la columna status (ciclo de vida) — el mismo eje sobre el que filtra la tabla. Honra los mismos filtros que GET /v1/validations (date_from, date_to, type, search, with_deleted, playground, batch_id, bank, amount_min/amount_max). El filtro status se acepta pero se ignora a nivel repo — cada KPI lleva su propio target.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
amount_max | query | number (float) | opcional | Monto máximo inclusive (normalized_data, fallback request_data). |
amount_min | query | number (float) | opcional | Monto mínimo inclusive (normalized_data, fallback request_data). |
bank | query | string | opcional | Restringe los contadores a la clave SPEI de 3 dígitos del banco (receptor o emisor). Solo dígitos, máximo 5 caracteres. |
batch_id | query | integer | opcional | Restringe los contadores al lote de un import masivo. |
date_from | query | string (date) | opcional | Fecha inicial inclusive (YYYY-MM-DD). |
date_to | query | string (date) | opcional | Fecha final inclusive (YYYY-MM-DD). |
playground | query | string | opcional | Cuando vale `'1'`, restringe a sandbox. |
search | query | string | opcional | Búsqueda en clave de rastreo, referencia numérica, emisor y receptor. |
type | query | string | opcional | Filtrar por tipo de validación. |
with_deleted | query | string | opcional | Tri-state: omitir = todas; `'1'` = solo eliminadas; `'0'` = solo activas. |
curl -X GET 'https://api.veriko.mx/v1/validations/stats' \
-H 'Authorization: Bearer mxcep_••••'
Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
type | string | Tipo del recurso JSON:API (siempre `validation_stats`). |
attributes | object | Conteos agregados de validaciones del usuario (cumpliendo los filtros). Los cubos de primer nivel cuentan por `banxico_status` (veredicto); `by_status` desglosa por la columna `status` (ciclo de vida). |
total | integer | Cantidad total de validaciones del usuario que cumplen los filtros. Incluye todas, sin importar el estado Banxico. |
valid | integer | Subconjunto del total con `banxico_status='valid'` (transferencia confirmada). |
not_found | integer | Subconjunto del total con `banxico_status='not_found'`. |
cep_unavailable | integer | Subconjunto del total con `banxico_status='cep_unavailable'` (el servicio CEP de Banxico no estaba disponible al momento de validar). |
error | integer | Subconjunto del total con `banxico_status='error'` (error Banxico, p.ej. HTTP 5xx o fallo de red). |
pending | integer | Subconjunto del total con `banxico_status='pending'`: validaciones asíncronas aún en cola o en proceso, sin resultado CEP todavía. |
deleted | integer | Cantidad de validaciones soft-deleted del usuario (cumpliendo los mismos filtros). |
other | integer | Resto del total tras restar `valid`, `not_found`, `cep_unavailable`, `error` y `pending`. En la práctica corresponde a filas `invalid`. Se calcula como `max(0, total - valid - not_found - cep_unavailable - error - pending)`. |
by_type | object | Desglose por tipo de validación. `direct + ocr` siempre suma `total`. |
direct * | integer | Validaciones directas (por campos CLABE/tarjeta/teléfono). |
ocr * | integer | Validaciones por OCR de comprobante. |
by_status | object | Desglose por estado de ciclo de vida (columna `status`: `queued` / `processing` / `valid` / `not_found` / `cep_unavailable` / `invalid` / `failed` / `error`). Es el MISMO eje sobre el que filtra la tabla de validaciones (a diferencia de `valid` / `not_found` / `cep_unavailable` / `error` / `pending` arriba, que cuentan por `banxico_status`): una fila en curso aparece como `processing`/`queued` aquí, pero como `pending` en aquellos cubos. Las ocho llaves siempre están presentes (0 si no hay filas) y siempre suman `total`. |
queued * | integer | Validaciones en cola, aún sin procesar (asíncronas). |
processing * | integer | Validaciones en proceso contra Banxico ahora mismo. |
valid * | integer | Validaciones con estado de ciclo de vida `valid` (confirmadas). |
not_found * | integer | Validaciones con estado `not_found`. |
cep_unavailable * | integer | Validaciones con estado `cep_unavailable`. |
invalid * | integer | Validaciones con estado `invalid` (entrada inválida). |
failed * | integer | Validaciones con estado `failed` (fallo del pipeline). |
error * | integer | Validaciones con estado `error`. |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Estadísticas agregadas de validaciones del usuario. | Sin cuerpo |
| 401 | 4xx | Se requiere autenticación o las credenciales son inválidas | ErrorResponse |
| Código | Clave | Detalle |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|