← Back to schema index

BanxicoPublicTimeseriesResponse

Response from `GET /v1/status/banxico/timeseries`. Data points bucketed by time interval for the requested metric and window. Only exposes safe metrics (`probe_latency`, `verdict`); invalid query values silently fall back to defaults (`probe_latency`, `24h`).

Properties

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
type*stringJSON:API resource type. Always `banxico_public_timeseries`.
id*stringIdentifier derived from the metric/window pair (`<metric>_<window>`).
attributes*objectTime-series of Banxico CEP service health metrics in time buckets. Returned by `GET /v1/banxico/timeseries`.
metricstringReported metric: `probe_latency` — health probe latency in milliseconds; `verdict` — Banxico verdict distribution per bucket.
windowstringTotal time window covered by the series (`1h`, `8h`, `12h`, `24h`, or `7d`).
unitstringUnit of measurement for values: `ms` for `probe_latency`, `verdict` (integer 0/1/2) for `verdict`.
bucket_size_minutesintegerSize of each time bucket in minutes.
pointsarrayData points in chronological order. Each point contains `ts` (bucket start timestamp) and `value` (integer in ms for `probe_latency`, verdict integer 0/1/2 for `verdict`).
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec.
timezone*stringAlways `UTC` — the canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601` — explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

  • GET /v1/status/banxico/timeseries