← 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 validation service health metrics, bucketed by time interval, as returned by `GET /v1/status/banxico/timeseries`.
metricstringReported metric — `probe_latency`: average health probe latency in milliseconds; `verdict`: the bucket's Banxico verdict, encoded as a number.
windowstringTotal time window covered by the series (`1h`, `8h`, `12h`, `24h`, or `7d`).
unitstringUnit of the values — `ms`: milliseconds, when `metric` is `probe_latency`; `verdict`: a categorical code rather than a magnitude, when `metric` is `verdict`.
bucket_size_minutesintegerSize of each interval in minutes — `1`: For the `1h` window; `60`: For the `8h`, `12h`, `24h` and `7d` windows.
pointsarrayData points in chronological order. Each point contains `ts` (bucket start timestamp) and `value` (number in ms for `probe_latency`; verdict code 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 the `meta` block of every response (and in the `meta` of outgoing webhook bodies). 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