Skip to main content
POST
Query Project

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

Query Parameters

environment
string

Environment slug to scope this operation to. Defaults to "production". An environment that does not exist on the project answers 404. Metrics are isolated to the addressed environment.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Body

application/json
names
enum<string>[]
required

One to 10 metric names.

Required array length: 1 - 10 elements
Available options:
cpu.percent,
memory.used_bytes,
memory.limit_bytes,
disk.used_bytes,
disk.limit_bytes,
disk.read_iops,
disk.write_iops,
network.receive_bytes,
network.transmit_bytes,
runtime.restarts,
runtime.uptime_seconds,
http.requests,
http.errors,
database.connections,
database.pool_waiting,
database.queries_per_second,
database.query_latency_avg_ms,
database.query_latency_p50_ms,
database.query_latency_p90_ms,
database.query_latency_p95_ms,
database.query_latency_p99_ms,
queue.backlog_messages,
queue.oldest_message_age_seconds,
cron.failures
from
string<date-time>
required
until
string<date-time>
required
stepSeconds
integer

Bucket width. Raw one-minute data is retained for 30 days; hourly aggregates for 13 months.

aggregation
enum<string>
Available options:
avg,
min,
max,
sum,
p50,
p95,
p99
groupBy
enum<string>[]
Available options:
instance,
process,
route,
status,
queue,
cron

Response

Metric series in ascending timestamp order.

from
string<date-time>
required
until
string<date-time>
required
stepSeconds
integer
required
series
object[]
required