UPuptime
metrics

GET /api/v1/metrics/checks/query/

Returns time-series datapoints with time bucketing and aggregation for one check.

data_type and metrics are optional — same defaults as the raw endpoint. granularity defaults to auto; aggregation defaults to avg.

Accepts both GET and POST with identical semantics.

Request

Query parameters

check_idinteger required

The check to query.

data_typestring

MDB data type (e.g. http, pagespeed, float). When omitted, resolved from the check's check type.

unknown

Metric names to return. Pass as repeated query params in GET (metrics=a&metrics=b) or as a JSON array in POST. When omitted, only the first metric defined for the data type is returned. Always specify the metrics you actually need. The default selection is not part of the API contract and may change.

start_datestring

Range start (ISO 8601, UTC). Defaults to 24 hours ago.

end_datestring

Range end (ISO 8601, UTC). Defaults to now.

granularity'auto' | '1min' | '15min' | '1hour' | '1day' | '1week' | '1month'

Time bucketing (default: auto).

aggregation'avg' | 'min' | 'max' | 'sum' | 'count' | 'median' | 'p75' | 'p90' | 'p95' | 'p99'

Aggregation function (default: avg).

filtersobject

Dimension filters (POST only). Object with dimension names as keys and arrays of values: {"location": ["us-east-1"]}. In GET, pass dimensions as direct query params instead (location=us-east-1&location=eu-west-1).

unknown

Dimensions to group by. Pass as repeated query params in GET (group_by=location&group_by=step_number) or as a JSON array in POST.

limitinteger

Max total datapoints across all series (default: 5000, max: 50000).

Response

check_idinteger required

The check to query.

data_typestring

MDB data type (e.g. http, pagespeed, float). When omitted, resolved from the check's check type.

metricsstring[]

Metric names to return. Pass as repeated query params in GET (metrics=a&metrics=b) or as a JSON array in POST. When omitted, only the first metric defined for the data type is returned. Always specify the metrics you actually need. The default selection is not part of the API contract and may change.

start_datestring date-time

Range start (ISO 8601, UTC). Defaults to 24 hours ago.

end_datestring date-time

Range end (ISO 8601, UTC). Defaults to now.

granularity'auto' | '1min' | '15min' | '1hour' | '1day' | '1week' | '1month'

Time bucketing (default: auto).

aggregation'avg' | 'min' | 'max' | 'sum' | 'count' | 'median' | 'p75' | 'p90' | 'p95' | 'p99'

Aggregation function (default: avg).

filtersobject

Dimension filters (POST only). Object with dimension names as keys and arrays of values: {"location": ["us-east-1"]}. In GET, pass dimensions as direct query params instead (location=us-east-1&location=eu-west-1).

group_bystring[]

Dimensions to group by. Pass as repeated query params in GET (group_by=location&group_by=step_number) or as a JSON array in POST.

limitinteger nullable

Max total datapoints across all series (default: 5000, max: 50000).

Changes

No recorded changes to this operation across all 1 revision of this API.