dots.v2.insights.query.byRegion().prom.api.v1.query_range.get()

Generated on 5 Nov 2026 from DoTs version v1.23.0

Usage

client.v2.insights.query.byRegion(region).prom.api.v1.query_range.get(requestConfiguration?: RequestConfiguration<Query_rangeRequestBuilderGetQueryParameters>): Promise<undefined | Prom_query_range_response>

Description

To evaluate a PromQL expression over a time range, send a GET request to /v2/insights/query/{region}/prom/api/v1/query_range.

Parameters

Path Parameters

region string required

Example: nyc3

The datacenter region slug for the query.

Query Parameters

query string required

Example: do.droplets.cpu_time

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])).

start string required

Example: 1620683817

Start timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp.

end string required

Example: 1620705417

End timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp.

step string required

Example: 15s

Query resolution step width as a Prometheus duration string (for example 15s, 1m, 1h).

timeout string optional

Example: 30s

Optional evaluation timeout as a Prometheus duration string.

Request Sample

Show Request Sample
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.insights.query
    .byRegion("nyc3").prom.api.v1.query_range.get({
    queryParameters: {
        query: "do.droplets.cpu_time",
        start: "1620683817",
        end: "1620705417",
        step: "15s",
    },
});

Response Example

Show Response Example
{
  "status": "success",
  "data": {
    "resultType": "matrix",
    "result": [
      {
        "metric": {
          "__name__": "do_droplets_cpu_time"
        },
        "values": [
          [
            1620683817,
            "1"
          ],
          [
            1620683832,
            "1"
          ]
        ]
      }
    ]
  }
}

More Information

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

We can't find any results for your search.

Try using different keywords or simplifying your search terms.