Skip to main content
GET
Workspace home dashboard rollup

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.

Response

Workspace-wide (not project-scoped) counters plus a per-project row set.

plan
enum<string>
required
Available options:
free,
starter,
standard,
team
quota
integer
required

Plan events-per-month allowance.

events_this_month
integer
required
deliveries_7d
integer
required
failed_7d
integer
required
error_rate_7d
number
required

failed_7d / (delivered_7d + failed_7d): a share of FINISHED deliveries, or 0 when none has finished. In-flight deliveries are in neither.

agent_runs_7d
integer
required
projects
object[]
required
ai_tokens_this_month
integer
required

AI tokens (input + output) used this billing month, across every AI call in the workspace.

ai_tokens_quota
integer
required

The plan's monthly AI token allowance. A call made once it is used is refused and the step fails.

agent_runs_this_month
integer
required

AI trigger runs counted against this billing month's limit: the workspace's running and done runs created since the 1st (UTC). The same count a run is refused on, so a failed or still-queued run is not in it (#260).

agent_runs_quota
integer
required

The plan's monthly AI trigger run limit (agentRunsPerMonth). No soft cap: once agent_runs_this_month reaches it, each further AI trigger run fails until the month resets. Events are still stored and delivered.

deliveries_this_month
integer | null
required

Deliveries charged against this month's allowance (#159); null if the usage counter could not be read.

deliveries_quota
integer
required

Plan deliveries-per-month allowance.

deliveries_ceiling
integer
required

Allowance plus soft overage; past it deliveries are held.

failing_destinations
object[]
required

OBS-2: the workspace's destinations that are failing (a delivery went dead and none has arrived since) or were switched off automatically, switched-off first. Home shows a notice for each, with a one-click re-enable.

Maximum array length: 20
plan_name
string
required

The plan's display name (Free, Starter, Pro, Team) - what users see. plan is the internal id.

delivered_7d
integer
required
in_flight_7d
integer
required

Deliveries in the last 7 days still queued, retrying or held by a paused destination - no outcome yet.

destinations
integer
required

Destinations in the workspace (deleted ones excluded).