Skip to main content
GET
/
v0
/
metrics
/
query_range
Query metric time series
curl --request GET \
  --url https://controller.platform.simplecloud.app/v0/metrics/query_range \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>'
{
  "series": [
    {
      "labels": {},
      "metric": "<string>",
      "points": [
        {
          "timestamp": "<string>",
          "value": 123
        }
      ]
    }
  ]
}

Headers

​
X-Network-ID
string
required

Network ID

​
X-Network-Secret
string
required

Network Secret

Query Parameters

​
metrics
string
required

Comma-separated metric names (e.g., server.cpu_usage_percent,server.memory_usage_mb)

​
from
string
required

Start timestamp in RFC3339 format (e.g., 2025-12-24T00:00:00Z)

​
to
string
required

End timestamp in RFC3339 format (e.g., 2025-12-24T12:00:00Z)

​
step
string

Aggregation interval (e.g., 5m, 1h). Auto-calculated if omitted

​
group_by
string

Label to group by (e.g., server_group_name, persistent_server_name)

​
aggregation
string

Aggregation function: avg (default), sum, max, min

​
server_ids
string

Comma-separated server IDs to filter

​
server_group_ids
string

Comma-separated server group IDs to filter

​
persistent_server_ids
string

Comma-separated persistent server IDs to filter

​
server_type
string

Comma-separated server group types to filter (e.g., SERVER, PROXY)

Response

OK

​
series
object[]