Give Feedback

pydo.insights.get_prom_query()

Generated on 16 Oct 2026 from pydo version v0.44.0

Copy page as Markdown View page as Markdown

Usage

client.insights.get_prom_query(
    region="nyc3",
    query="do.droplets.cpu_time",
    time=None,
    timeout=None,
)

Returns JSON Raises HttpResponseError

Description

To evaluate a PromQL expression at a single point in time, send a GET request to /v2/insights/query/{region}/prom/api/v1/query.

Parameters

region string required: The datacenter region slug for the query.
query string required: A PromQL expression. This may be a metric selector (for example do.droplets.cpu_time) or a fuller expression (for example rate(do.droplets.cpu_time[5m])).
time string optional: Evaluation timestamp for an instant query. Accepts a RFC3339 string or a UNIX timestamp. Defaults to now when omitted.
timeout string optional: Optional evaluation timeout as a Prometheus duration string.

Response Example

Show Response Example

{
  "status": "success",
  "data": {
    "resultType": "vector",
    "result": [
      {
        "metric": {
          "__name__": "do_droplets_cpu_time"
        },
        "value": [
          1620683817,
          "1"
        ]
      }
    ]
  }
}

More Information

See /v2/insights/query/{region}/prom/api/v1/query in the API reference for additional detail on responses, headers, parameters, and more.