← Volver al índice de esquemas

DashboardSummary

Snapshot del panel 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

CampoTipoDescripción
type*stringTipo del recurso, fijo para esta operación. Forma parte de la identidad del recurso en la envoltura JSON:API. Siempre `dashboard_summary`.
attributes*objectAtributos agregados del panel del usuario (conteos, tasa de éxito, progreso del onboarding).
total_validationsintegerTotal acumulado de validaciones del usuario (todos los meses).
monthly_validationsintegerValidaciones del mes calendario en curso (UTC).
pending_monthintegerValidaciones del mes en curso aún en estado no terminal (`queued` o `processing`).
valid_validationsintegerValidaciones del usuario con veredicto `valid` (acumulado histórico).
avg_ticketnumberTicket 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_percentnumberTasa de éxito como porcentaje (0-100) sobre el total de validaciones.
beneficiaries_countintegerCantidad de beneficiarios activos del usuario.
comenzar_milestones_completedintegerCuenta 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.
relationshipsobjectRelaciones JSON:API del panel (referencias a recursos asociados).
recent_validationsobjectRelación JSON:API con las validaciones recientes mostradas en el panel.
dataarrayCuerpo de la respuesta. Todo el contenido cuelga de aquí, según la envoltura JSON:API.

Usado en operaciones

  • GET /v1/summary