← Back to schema index

BanxicoPublicTimeseriesResource

JSON:API resource carrying the timeseries for the requested metric/window pair.

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
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`).

Used in operations

  • GET /v1/status/banxico/timeseries

Referenced by schemas