Skip to main content
GET
Get analytics

Authorizations

api_key
string
header
required

API key for authentication. See the Authentication page for your API for details on how to get your key.

Path Parameters

workspace_id
string
required

Query Parameters

from
string | null

Start date in YYYY-MM-DD format. Defaults to billing period start.

to
string | null

End date in YYYY-MM-DD format. Defaults to current date. Max 1 year range.

Response

Successful Response

Workspace analytics data.

summary
AnalyticsSummary · object
required

High-level workspace summary.

user_distribution
AnalyticsUserDistribution · object
required

User distribution breakdown.

app_distribution
AnalyticsAppDistribution · object
required

App distribution statistics.

seats
SeatsUtilization · object
required
deprecated

Deprecated: Workspace seat utilization metrics. Use credit_pool instead. Workspaces on the current billing model share a credit pool with no per-user seats, so this block reports zeros for them.

credit_pool
CreditPool · object
required

Workspace credit pool state for the current credit reset period.

member_allocations
MemberAllocationsSummary · object
required

Aggregate view of per-member credit limits drawn from the shared pool.

credits
CreditsSummary · object
required

Credits consumption summary.