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

Consultar las métricas de validaciones de la cuenta de usuario

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

Devuelve las métricas de validaciones para el usuario autenticado:

  • Total de validaciones
  • Validaciones de hoy y de ayer
  • Tasa de éxito
  • Latencia promedio de las últimas 24 horas

Incluye la distribución de veredictos de 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 Banxico de los últimos 7 días.
CampoTipoDescripción
totalinteger

Cantidad de validaciones en el alcance, sin acotar por fecha.

p. ej. 1240
todayinteger

Cantidad de validaciones creadas en el día calendario actual (UTC).

p. ej. 37
yesterdayinteger

Cantidad de validaciones creadas en el día calendario anterior (UTC).

p. ej. 42
success_ratenumber

Porcentaje de validaciones con veredicto valid sobre el total, 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 de Banxico de los últimos 7 días. Las claves son valores de banxico_status (valid, not_found, cep_unavailable, invalid, returned, error o pending); los valores ausentes implican cero.

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

Alcance de los datos — 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 Banxico de los últimos 7 días.InsightsOverviewAttributes
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
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d