Metrics

Fetch a time-series range for a single metric on a deployment.

get/deployments/{id}/metrics

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/deployments/{id}/metrics
  • Auth: HTTP bearer

Path parameters

idinteger required

Deployment ID

Query parameters

metricstring required

Metric name, e.g. "pg.connections_active".

rangestring

Time window: "1h" | "6h" | "24h" | "7d". Ignored when start_time and end_time are both set.

percentilenumber double nullable

Optional histogram percentile (0–100). When provided, the endpoint fetches histogram buckets and computes the requested quantile.

start_timestring nullable

Explicit window start (ISO 8601). Must be paired with end_time.

end_timestring nullable

Explicit window end (ISO 8601). Must be paired with start_time.

Response

Metric time series data points

timestring required

ISO 8601 timestamp with Z suffix.

valuenumber double required

Metric value at this bucket.

Changes

No recorded changes to this operation across all 53 revisions of this API.