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

Obtener el resumen del panel

Audiencia
public
Autenticación
API key
Permiso
validations:read

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ámetros
ParámetroUbicaciónTipoObligatorioDescripción
limitqueryintegeropcional

Número máximo de validaciones recientes a devolver.

Predeterminado: 5

p. ej. 5
Petición
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 200DashboardSummary — Resumen del panel del usuario.
CampoTipoDescripció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.

p. ej. dashboard_summary
attributes*object

Atributos agregados del panel del usuario (conteos, tasa de éxito, progreso del onboarding).

total_validationsinteger

Total acumulado de validaciones del usuario (todos los meses).

p. ej. 1284
monthly_validationsinteger

Validaciones del mes calendario en curso (UTC).

p. ej. 96
pending_monthinteger

Validaciones del mes en curso aún en estado no terminal (queued o processing).

p. ej. 3
valid_validationsinteger

Validaciones del usuario con veredicto valid (acumulado histórico).

p. ej. 1160
avg_ticketnumber

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.

p. ej. 4302.32
success_rate_percentnumber

Tasa de éxito como porcentaje (0-100) sobre el total de validaciones.

p. ej. 0
beneficiaries_countinteger

Cantidad de beneficiarios activos del usuario.

p. ej. 12
comenzar_milestones_completedinteger

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.

p. ej. 0
relationshipsobject

Relaciones JSON:API del panel (referencias a recursos asociados).

recent_validationsobject

Relación JSON:API con las validaciones recientes mostradas en el panel.

dataarray

Cuerpo de la respuesta. Todo el contenido cuelga de aquí, según la envoltura JSON:API.

Códigos de respuestaGET /v1/summary
CódigoClaseDescripciónCuerpo
2002xxResumen del panel del usuario.Sin cuerpo
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
Errores de GET /v1/summary
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9