← Volver al índice de esquemas

DashboardSummary

Snapshot del dashboard del usuario. Devuelto por `GET /summary`. `attributes` cuenta validaciones agregadas; `relationships.recent_validations` lista hasta 10 validaciones recientes (parámetro `?limit=N`, default 5). `comenzar_milestones_completed` mide el progreso del wizard `/comenzar` y lo usa el flujo de post-login para decidir si saltarse esa pantalla.

Propiedades

Campo Tipo Descripción
type * string
attributes * object Atributos agregados del dashboard del usuario (conteos, tasa de éxito, progreso del onboarding).
total_validations integer Total acumulado de validaciones del usuario (todos los meses).
monthly_validations integer Validaciones del mes calendario en curso (UTC).
pending_month integer Validaciones del mes en curso aún en estado no terminal (`queued` o `processing`).
valid_validations integer Validaciones del usuario con veredicto `valid` (acumulado histórico).
avg_ticket number Ticket promedio (all-time) del usuario: promedio del monto sobre TODAS sus validaciones con monto > 0 (excluye playground y soft-deleted). `0` cuando no tiene ningún monto positivo.
success_rate_percent number Tasa de éxito como porcentaje (0-100) sobre el total de validaciones.
beneficiaries_count integer Cantidad de beneficiarios activos del usuario.
comenzar_milestones_completed integer Cuenta de hitos completados del wizard `/comenzar`: (1) ≥1 validación OCR, (2) ≥1 validación directa, (3) ≥1 beneficiario, (4) (1) AND (2). Total máximo: 4.
relationships object Relaciones JSON:API del dashboard (referencias a recursos asociados).
recent_validations object Relación JSON:API con las validaciones recientes mostradas en el dashboard.
data array

Usado en operaciones

  • GET /v1/summary