Skip to main content
GET
Get stats aggregated by workspace

Authorizations

Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Query Parameters

period
enum<string>
required
Available options:
day,
week,
month,
custom
Example:

"week"

startDate
string
Example:

"2026-01-01"

endDate
string
Example:

"2026-01-31"

workspaceId
string

Filter by workspace ID (must be within API key scope)

Response

Workspace stats response

aggregate
object
required
workspaces
object[]
required