Sign in
Workspace

Get workspace usage data

Deprecated: this endpoint will be removed after 2026-07-01. Use GET /api/v1/w/{wId}/analytics/export instead.

Get usage data for the workspace identified by {wId} in CSV or JSON format.

get/api/v1/w/{wId}/workspace-usage

Path parameters

wIdstring required

Unique string identifier for the workspace

Query parameters

startstring required

The start date in YYYY-MM or YYYY-MM-DD format

endstring

The end date in YYYY-MM or YYYY-MM-DD format (required when mode is 'range')

mode'month' | 'range' required

The mode of date range selection

format'csv' | 'json'

The output format of the data (defaults to 'csv')

table'users' | 'assistant_messages' | 'builders' | 'assistants' | 'feedback' | 'all' required

The name of the usage table to retrieve:

  • "users": The list of users categorized by their activity level.
  • "assistant_messages": The list of messages sent by users including the mentioned agents.
  • "builders": The list of builders categorized by their activity level.
  • "assistants": The list of workspace agents and their corresponding usage.
  • "feedback": The list of feedback given by users on the agent messages.
  • "all": A concatenation of all the above tables.
includeInactiveboolean

Include users and assistants with zero messages in the export (defaults to false)

Response

The usage data in CSV or JSON format, or a ZIP of multiple CSVs if table is equal to "all"

object required

Changes