Skip to main content
GET
Bucketed activity series for the workspace

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Query Parameters

window
enum<string>
default:7d

Time window. Defaults to 7d.

Available options:
24h,
7d,
30d
metric
enum<string>
default:events

Which table to count. Defaults to events.

Available options:
events,
deliveries,
agent_runs
project_id
string

Count only this project's rows. Applied together with the workspace, so an id from another workspace matches nothing.

Response

Equal-width buckets ending now. 24h and 7d are hourly (24 and 168 buckets); 30d is daily (30 buckets). Counted in SQL, with no cap on volume.

window
enum<string>
required
Available options:
24h,
7d,
30d
metric
enum<string>
required
Available options:
events,
deliveries,
agent_runs
since
string<date-time>
required
until
string<date-time>
required
bucket_ms
integer
required
values
integer[]
required
previous_total
integer

The metric's total over the window of the same length just before this one, for a change-on-previous-period figure.