https://api.veriko.mx/v1/summaryObtener el resumen del panel
Devuelve los contadores agregados de validaciones del usuario y, en relationships.recent_validations, las últimas N validaciones (parámetro ?limit=, default 5, máximo 10). Incluye además comenzar_milestones_completed para el wizard /comenzar.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
limit | query | integer | opcional | Número máximo de validaciones recientes a devolver. Predeterminado: 5 |
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.
| Campo | Tipo | Descripción |
|---|---|---|
type* | string | Tipo del recurso, fijo para esta operación. Forma parte de la identidad del recurso en la envoltura JSON:API. Siempre dashboard_summary |
attributes* | object | Atributos agregados del panel del usuario (conteos, tasa de éxito, progreso del onboarding). |
total_validations | integer | Total acumulado de validaciones del usuario (todos los meses). p. ej.1284 |
monthly_validations | integer | Validaciones del mes calendario en curso (UTC). p. ej.96 |
pending_month | integer | Validaciones del mes en curso aún en estado no terminal ( 3 |
valid_validations | integer | Validaciones del usuario con veredicto 1160 |
avg_ticket | number | Ticket promedio (all-time) del usuario: promedio del monto sobre TODAS sus validaciones con monto > 0 (excluye playground y soft-deleted). 4302.32 |
success_rate_percent | number | Tasa de éxito como porcentaje (0-100) sobre el total de validaciones. p. ej.0 |
beneficiaries_count | integer | Cantidad de beneficiarios activos del usuario. p. ej.12 |
comenzar_milestones_completed | integer | Cuenta de hitos completados del wizard 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 | Cuerpo de la respuesta. Todo el contenido cuelga de aquí, según la envoltura JSON:API. |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Resumen del panel del usuario. | Sin cuerpo |
| 401 | 4xx | Se requiere autenticación o las credenciales son inválidas | ErrorResponse |
| Código | Clave | Ejemplo |
|---|---|---|
| 401 | unauthorized | Credenciales de autenticación ausentes o inválidas. Envelope
|