GEThttps://api.veriko.mx/v1/insights/overview

Consultar los indicadores de la cuenta

Audiencia
public
Autenticación
API key
Permiso
insights:read_self
Guía de uso →

Devuelve los indicadores clave del usuario:

  • total de validaciones
  • consumo de hoy y ayer
  • tasa de éxito
  • latencia promedio de las últimas 24 horas

Incluye la distribución de veredictos Banxico de los últimos 7 días.

Petición
curl -X GET 'https://api.veriko.mx/v1/insights/overview' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200InsightsOverviewAttributes — KPIs propios del usuario y distribución de veredictos de los últimos 7 días.
CampoTipoDescripción
totalinteger

Total de validaciones en el alcance y periodo seleccionado.

p. ej. 1240
todayinteger

Validaciones creadas en el día calendario actual (UTC).

p. ej. 37
yesterdayinteger

Validaciones creadas en el día calendario anterior (UTC).

p. ej. 42
success_ratenumber

Porcentaje de validaciones con veredicto valid sobre el total completado, expresado de 0 a 100.

p. ej. 94.2
avg_latency_msinteger

Tiempo promedio de procesamiento en milisegundos de las últimas 24 horas.

p. ej. 810
by_banxico_7dobject

Distribución de veredictos Banxico de los últimos 7 días. Las claves son valores del enum de veredicto (valid, not_found, cep_unavailable, error). Los valores ausentes implican cero.

p. ej. {"valid":210,"invalid":8,"not_found":3,"cep_unavailable":2}
scopestring

Alcance del overview: self — solo las validaciones del usuario autenticado; global — todas las validaciones de la plataforma (solo para administradores).

p. ej. self
Códigos de respuestaGET /v1/insights/overview
CódigoClaseDescripciónCuerpo
2002xxKPIs propios del usuario y distribución de veredictos de los últimos 7 días.Sin cuerpo
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
Errores de GET /v1/insights/overview
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0