Sign in

v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01206322659.2 KB
alarms

Query a metric series

Time-bucketed count/sum/avg/min/max for one metric, with optional dimension filters.

Needs analytics.read for an unrestricted query. Passing project_id also accepts projects.alarms.read on that project, so a project-scoped role can read the series behind its own alarms.

get/orgs/{org_id}/metrics

Path parameters

org_idstring required

Query parameters

namestring required

Metric to read, e.g. app.run.errors, deployment.health.

period_secondsinteger nullable

Bucket size in seconds (multiple of 60). Default 60.

frominteger nullable

Inclusive range start (epoch milliseconds). Default: 100 buckets before to.

tointeger nullable

Exclusive range end (epoch milliseconds). Default: now.

project_idstring nullable

Filter to one project. Omit to aggregate across projects.

project_env_idstring nullable

Filter to one environment.

deployment_idstring nullable

Filter to one deployment.

workforce_idstring nullable

Filter to one agent/workflow app (OrgsApps.id).

labelstring nullable

Filter to one label — the span name behind a trace-derived metric (llm, get_address). Omit to sum across every label.

Response

Metric series

frominteger required

Range start (epoch milliseconds).

namestring required
period_secondsinteger required
tointeger required

Range end (epoch milliseconds).