← Volver al índice de esquemas
DashboardSummary
Resumen JSON:API del panel de la cuenta, con métricas agregadas, progreso de configuración y validaciones recientes.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
type* | string | Tipo de recurso JSON:API. Siempre `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). |
monthly_validations | integer | Cantidad de validaciones del mes calendario UTC en curso. Incluye las retiradas y las del banco de pruebas (Playground). |
pending_month | integer | Cantidad de validaciones no retiradas del mes UTC en curso cuyo estado almacenado es `queued` o `processing`. |
valid_validations | integer | Cantidad histórica de validaciones del usuario con veredicto `valid`. Incluye las retiradas y las del banco de pruebas (Playground). |
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. |
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`. |
beneficiaries_count | integer | Cantidad de beneficiarios activos del usuario. |
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`. |
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. |
Usado en operaciones
GET /v1/summary