← Volver al índice de esquemas

ValidationStats

Contadores agregados de las validaciones del usuario autenticado. Devuelto por `GET /v1/validations/stats`. Honra los mismos filtros que `GET /v1/validations` (`date_from`, `date_to`, `type`, `search`, `with_deleted`, `playground`, `batch_id`).

Propiedades

CampoTipoDescripción
typestringTipo del recurso JSON:API (siempre `validation_stats`).
attributesobjectConteos 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).
totalintegerCantidad total de validaciones del usuario que cumplen los filtros. Incluye todas, sin importar el estado Banxico.
validintegerSubconjunto del total con `banxico_status='valid'` (transferencia confirmada).
not_foundintegerSubconjunto del total con `banxico_status='not_found'`.
cep_unavailableintegerSubconjunto del total con `banxico_status='cep_unavailable'` (el servicio CEP de Banxico no estaba disponible al momento de validar).
errorintegerSubconjunto del total con `banxico_status='error'` (error Banxico, p.ej. HTTP 5xx o fallo de red).
pendingintegerSubconjunto del total con `banxico_status='pending'`: validaciones asíncronas aún en cola o en proceso, sin resultado CEP todavía.
deletedintegerCantidad de validaciones soft-deleted del usuario (cumpliendo los mismos filtros).
otherintegerResto 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_typeobjectDesglose por tipo de validación. `direct + ocr` siempre suma `total`.
direct*integerValidaciones directas (por campos CLABE/tarjeta/teléfono).
ocr*integerValidaciones por OCR de comprobante.
by_statusobjectDesglose 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*integerValidaciones en cola, aún sin procesar (asíncronas).
processing*integerValidaciones en proceso contra Banxico ahora mismo.
valid*integerValidaciones con estado de ciclo de vida `valid` (confirmadas).
not_found*integerValidaciones con estado `not_found`.
cep_unavailable*integerValidaciones con estado `cep_unavailable`.
invalid*integerValidaciones con estado `invalid` (entrada inválida).
failed*integerValidaciones con estado `failed` (fallo del pipeline).
error*integerValidaciones con estado `error`.

Usado en operaciones

  • GET /v1/validations/stats