Skip to main content

Querying Overview

xScaler exposes the full Prometheus HTTP API, so any tool that speaks PromQL works without modification: Grafana, custom dashboards, curl, and more.

Base URL

https://euw1-01.m.xscalerlabs.com

All query endpoints are relative to this base. Replace euw1-01 with your region.

Required headers

Every query request must include both headers:

Authorization: Bearer <token>
X-Scope-OrgID: <tenant-id>

A missing or mismatched X-Scope-OrgID returns 401 (x-scope-orgid mismatch). A missing or invalid Authorization also returns 401.


API endpoints

OperationMethodPath
Instant queryGET/api/v1/query
Range queryGET/api/v1/query_range
Label namesGET/api/v1/labels
Label valuesGET/api/v1/label/<name>/values
Series searchPOST/api/v1/series
Active alertsGET/api/v1/alerts
Rules listGET/api/v1/rules

Response envelope

All Prometheus API responses use the same JSON envelope:

{
"status": "success",
"data": {
"resultType": "vector",
"result": [...]
}
}

On error:

{
"status": "error",
"errorType": "bad_data",
"error": "invalid parameter 'query': ..."
}

Query timeout

Queries time out after 2 minutes. Wide time ranges with a fine step hit the limit first. Raise the step or narrow the range.


PromQL quick reference

PatternWhat it computes
rate(metric[5m])Per-second rate over a 5-minute window
sum(metric) by (label)Aggregate across all series, grouped by a label
histogram_quantile(0.99, sum(rate(metric_bucket[5m])) by (le))99th-percentile latency from a histogram
topk(10, metric)Top 10 series by value
count by (__name__)({__name__=~".+"})Series count per metric name