latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-21155184608.3 KB

9c654bb5b126

agent-telemetry

Agent Telemetry Series

Row volume over time, split by user or API key (standalone).

Mirrors /v1/usage/series: same window bounds and bucket-grid cap, the top groups as their own series with the remainder folded into a reconciling other, and sparse points (populated cells only). Counts rows, not spend, so it charts telemetry volume rather than cost. Master-key only.

get/v1/agent-telemetry/series

Query parameters

group_by'user_id' | 'api_key_id' required

Dimension to split the series by

Dimension to split the series by

start_datestring date-time nullable

Return rows with timestamp >= start_date (ISO 8601 or Unix epoch seconds)

Return rows with timestamp >= start_date (ISO 8601 or Unix epoch seconds)

end_datestring date-time nullable

Return rows with timestamp < end_date (ISO 8601 or Unix epoch seconds)

Return rows with timestamp < end_date (ISO 8601 or Unix epoch seconds)

user_idstring[] nullable

Filter to one or more users; repeatable (user_id=a&user_id=b). Several values match any of them. At most 50 per call.

Filter to one or more users; repeatable (user_id=a&user_id=b). Several values match any of them. At most 50 per call.

api_key_idstring[] nullable

Filter to one or more API key ids; repeatable (api_key_id=a&api_key_id=b). Several values match any of them. At most 50 per call.

Filter to one or more API key ids; repeatable (api_key_id=a&api_key_id=b). Several values match any of them. At most 50 per call.

namestring nullable

Filter to a single event type or metric name (e.g. 'tool_result', 'claude_code.commit.count')

Filter to a single event type or metric name (e.g. 'tool_result', 'claude_code.commit.count')

bucket'hour' | 'day'

Time-series granularity: 'hour' or 'day'

Time-series granularity: 'hour' or 'day'

Response

Successful Response

bucket'hour' | 'day' required
end_datestring required
group_by'user_id' | 'api_key_id' required
start_datestring required