GuidesAPI referenceLatest updatesSlack Community
API reference
Start typing to search…

Get workspace usage data

get
https://dust.tt/api/v1/w//workspace-usage

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

Path Params
string
required

Unique string identifier for the workspace

Query Params
string
required

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

string

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

string
enum
required

The mode of date range selection

Allowed:
string
enum

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

Allowed:
string
enum
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.
Allowed:
boolean

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Invalid request query

403

The workspace does not have access to the usage data API

404

The workspace was not found

405

Method not supported

Updated 7 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/csv
application/json
application/zip
Updated 7 months ago