Skip to main content
GET
List workspace usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The ID of the Organization to retrieve usage data for.

Query Parameters

startDate
string
required

Start of the date range (YYYY-MM-DD).

endDate
string
required

End of the date range (YYYY-MM-DD). Range must not exceed 12 months.

timeGrain
enum<string>
default:day

The granularity to aggregate by.

Available options:
day,
week,
month
workspaceId
string[]

Filter by workspace ID. At most 1000.

offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return.

Required range: 1 <= x <= 1000
sorts
string[]

Fields to sort by, formatted as <fieldName>:asc or <fieldName>:desc.

Response

OK

items
object[]
required

The list of workspace usage rows in the current page.

limit
integer
required

The maximum number of results in one page.

Example:

20

offset
integer
required

The offset of the current page of results.

Example:

0

totalCount
integer
required

The total number of workspace usage rows matching the query.

Example:

5139