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

Obtener las series temporales de validaciones de la cuenta de usuario

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

Devuelve una serie temporal que representa las validaciones del usuario autenticado, según el rango y la métrica seleccionados.

El tamaño del intervalo varía con el rango:

  • 24h: por hora.
  • 7d y 30d: por día.
  • 90d: por semana (con inicio en lunes).

La métrica volume desglosa entre validaciones manuales (direct) y por OCR (ocr).

La métrica latency devuelve los percentiles p50, p95 y p99.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
metricquerystringopcional

Filtro — Serie que se devuelve. Con volume, cada punto contiene la cantidad de validaciones; con latency, los percentiles del tiempo de procesamiento de las validaciones que tienen esa medición.

Predeterminado: volume

p. ej. volume
rangequerystringopcional

Filtro — Ventana temporal que cubre la serie: 24h (últimas 24 horas), 7d (últimos 7 días), 30d (últimos 30 días) o 90d (últimos 90 días). El tamaño del intervalo se ajusta a la ventana, de modo que dos consultas con ventanas distintas no son comparables punto por punto.

Predeterminado: 7d

p. ej. 7d
Petición
curl -X GET 'https://api.veriko.mx/v1/insights/trends' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200InsightsTrendsAttributes — Intervalos de la serie temporal para el rango y la métrica solicitados.
CampoTipoDescripción
rangestring

Ventana de tiempo de la serie: 24h (últimas 24 horas), 7d (últimos 7 días), 30d (últimos 30 días) o 90d (últimos 90 días).

p. ej. 7d
metricstring

Métrica representada — volume: conteos de validaciones apilados por tipo; latency: tiempos de procesamiento (en percentiles).

p. ej. volume
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
seriesarray

Puntos de datos ordenados cronológicamente. La forma de cada punto depende de metric: para volume incluye bucket, total, direct, ocr, valid, errored; para latency incluye bucket, p50, p95, p99, avg.

Códigos de respuestaGET /v1/insights/trends
CódigoClaseDescripciónCuerpo
2002xxIntervalos de la serie temporal para el rango y la métrica solicitados.InsightsTrendsAttributes
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
Errores de GET /v1/insights/trends
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