GEThttps://api.veriko.mx/v1/summary

Obtener el resumen del panel

Audiencia: public
Autenticación: API key
Permiso: validations:read

Devuelve los contadores agregados del usuario: el total histórico, el total del mes UTC en curso, las validaciones con veredicto valid, el contador mensual de los estados queued y processing, el monto promedio y la tasa de éxito. Incluye también la cantidad de beneficiarios activos.

relationships.recent_validations contiene las validaciones no retiradas más recientes. La cantidad se controla con ?limit=, entre 1 y 10; el valor predeterminado es 5.

comenzar_milestones_completed indica el progreso del wizard /comenzar.

Parámetros
Parámetro	Ubicación	Tipo	Obligatorio	Descripción
`limit`	query	`integer`	opcional	Filtro — Número máximo de validaciones recientes a devolver. Entre `1` y `10`; el valor predeterminado es `5`. Predeterminado: `5` p. ej. `5`

Petición

cURLPython•JavaScript•PHP•

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

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

**Respuesta 200**`DashboardSummary` — Resumen del panel del usuario autenticado.
Campo	Tipo	Descripción
`type`*	`string`	Tipo de recurso JSON:API. Siempre `dashboard_summary`. p. ej. `dashboard_summary`
`attributes`*	`object`	Datos agregados del panel del usuario: conteos, tasa de éxito y progreso del onboarding.
`total_validations`	`integer`	Cantidad histórica de validaciones del usuario. Incluye las retiradas y las del banco de pruebas (Playground). p. ej. `1284`
`monthly_validations`	`integer`	Cantidad de validaciones del mes calendario UTC en curso. Incluye las retiradas y las del banco de pruebas (Playground). p. ej. `96`
`pending_month`	`integer`	Cantidad de validaciones no retiradas del mes UTC en curso cuyo estado almacenado es `queued` o `processing`. p. ej. `3`
`valid_validations`	`integer`	Cantidad histórica de validaciones del usuario con veredicto `valid`. Incluye las retiradas y las del banco de pruebas (Playground). p. ej. `1160`
`avg_ticket`	`number`	Monto promedio por validación en MXN. Se calcula sobre toda la historia del usuario y sólo con montos mayores que `0`; excluye las validaciones del banco de pruebas (Playground) y las retiradas. Devuelve `0` cuando no hay ningún monto positivo. p. ej. `4302.32`
`success_rate_percent`	`number`	Tasa de éxito, expresada de `0` a `100`: `valid_validations` entre `total_validations`, redondeada a un decimal. La población histórica es la misma e incluye las validaciones retiradas y las del banco de pruebas (Playground); devuelve `0` cuando el total es `0`. p. ej. `90.3`
`beneficiaries_count`	`integer`	Cantidad de beneficiarios activos del usuario. p. ej. `12`
`comenzar_milestones_completed`	`integer`	Cantidad de hitos completados del wizard `/comenzar`: (1) existe al menos una validación OCR no retirada, (2) existe al menos una validación manual no retirada, (3) existe al menos un beneficiario activo y (4) se cumplen a la vez (1) y (2). Total máximo: `4`. p. ej. `0`
`relationships`	`object`	Relaciones JSON:API del panel (referencias a recursos asociados).
`recent_validations`	`object`	Relación JSON:API con las validaciones recientes mostradas en el panel.
`data`	`array`	Validaciones recientes, cada una como recurso compacto.

**Códigos de respuesta**`GET /v1/summary`
Código	Clase	Descripción	Cuerpo
200	`2xx`	Resumen del panel del usuario autenticado.	`DashboardSummary`
401	`4xx`	Se requiere autenticación o las credenciales son inválidas	`ErrorResponse`

**Errores de `GET /v1/summary`**
Código	Clave	Ejemplo
401	`unauthorized`	Credenciales de autenticación ausentes o inválidas. Envelope meta.request_id `c4d5e6f7a8b99b8a7f6e5d4c`