v2

OpenAPI 3.0.02026-08-051996591.2 MB

CustomerMetrics

Query a metric time series

Returns a time series of aggregated metric values for the named metric within the requested time range.

get/v2/metrics/{metric_name}

Path parameters

metric_namestring required

The name of the metric to query (see /v2/metrics for the catalog).

Query parameters

labelsobject

Label filters keyed by label name. Each metric's descriptor at /v2/metrics lists its valid label names.

startstring date-time required

The inclusive start of the query window (ISO 8601). Must be no more than 30 days before now.

endstring date-time required

The exclusive end of the query window (ISO 8601). Must be after start.

max_binsinteger

The upper bound on the number of points in the response. The response may contain fewer points than requested but never more. The response reports the actual time-bin size as bin_size_seconds. Defaults to 60.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The requested metric series.

Example response

{
  "type": "counter"
}