GEThttps://api.veriko.mx/v1/status/banxico/timeseries

Obtener la serie temporal de salud del servicio de verificación de Banxico

Audiencia
public
Autenticación
API key

Devuelve el estado operativo histórico del servicio de verificación de Banxico, agrupado en puntos de datos por intervalo de tiempo para la métrica y ventana solicitadas.

El tamaño del intervalo depende de la ventana:

  • 1h: Intervalo por minuto.
  • 8h, 12h, 24h y 7d: Intervalo por hora.

Expone las métricas probe_latency y verdict.

La respuesta se cachea 60 segundos en el cliente con Cache-Control, y ese plazo se configura en el despliegue. Cualquier usuario autenticado puede consultarlo, y no hace falta ningún permiso concreto.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
metricquerystringopcional

Filtro — Serie que se devuelve. probe_latency: Cada punto es el promedio de latencia (en milisegundos); verdict: El veredicto Banxico del grupo (el más reciente), codificado como 0, 1 o 2.

Predeterminado: probe_latency

p. ej. probe_latency
windowquerystringopcional

Filtro — Ventana que cubre la serie: 1h, 8h, 12h, 24h y 7d. 1h agrupa por minuto; el resto por hora.

Predeterminado: 24h

p. ej. 24h
Petición
curl -X GET 'https://api.veriko.mx/v1/status/banxico/timeseries' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200BanxicoPublicTimeseriesResponse — Puntos de datos de la serie temporal.
CampoTipoDescripción
dataobject

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

type*string

Tipo del recurso JSON:API. Siempre banxico_public_timeseries.

p. ej. banxico_public_timeseries
id*string

Identificador derivado del par métrica/ventana (<metric>_<window>).

p. ej. probe_latency_24h
attributes*object

Serie temporal de métricas de salud del servicio de verificación de Banxico, agrupada por intervalos de tiempo, tal como la devuelve GET /v1/status/banxico/timeseries.

metricstring

Métrica reportada — probe_latency: Promedio de latencia de las pruebas (en milisegundos); verdict: Veredicto Banxico del grupo (codificado como número).

p. ej. probe_latency
windowstring

Ventana de tiempo total cubierta por la serie (1h, 8h, 12h, 24h o 7d).

p. ej. 24h
unitstring

Unidad de los valores — ms: Milisegundos, cuando metric es probe_latency; verdict: Código categórico y no una magnitud, cuando metric es verdict.

p. ej. ms
bucket_size_minutesinteger

Tamaño de cada intervalo en minutos — 1: Para la ventana 1h; 60: Para las ventanas 8h, 12h, 24h y 7d.

p. ej. 60
pointsarray

Puntos de datos ordenados cronológicamente. Cada punto contiene ts, la marca de tiempo de inicio del intervalo, y value, que es un número en milisegundos para probe_latency y un código de veredicto para verdict.

metaobject

Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

Descriptor compañero presente en el bloque meta de cada respuesta (y en el meta del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC: La zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601: Sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaGET /v1/status/banxico/timeseries
CódigoClaseDescripciónCuerpo
2002xxPuntos de datos de la serie temporal.BanxicoPublicTimeseriesResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Cache-ControlstringTTL de caché para la vista pública (configurable; default 60 s).
VarystringVariación por Origin (CORS).
Errores de GET /v1/status/banxico/timeseries
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c