v2

latestOpenAPI 3.1.02026-08-014610794.4 KB
dashboard

Aggregate Usage Events

List usage events sorted chronologically by timestamp. Events can be filtered by workspace, user, or access token.

Filter combinations:

  • Multiple filters (e.g. workspace_id & user_id) use AND logic
  • Multiple values for same filter (e.g. workspace_id=123&workspace_id=456) use OR logic

Pagination:

  • Use starting_after with event IDs for cursor-based navigation
  • has_more indicates if more events exist beyond limit
  • total_count (optional) shows total matching events up to 100,000
get/api/v1/dashboard/usage

Query parameters

workspace_idsstring[] required

Filter by workspace IDs. Must contain at least one ID.

Filter by workspace IDs. Must contain at least one ID.

start_timestring date-time required

Include events starting from this date (inclusive)

Include events starting from this date (inclusive)

end_timestring date-time required

Include events until this date (exclusive)

Include events until this date (exclusive)

user_idsstring[] nullable

Filter by user IDs

Filter by user IDs

Response

Usage events listed successfully