Skip to main content
POST
/
export
/
users
Export user usage data
curl --request POST \
  --url https://api.langdock.com/export/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": {
    "date": "2024-01-01T00:00:00.000Z",
    "timezone": "UTC"
  },
  "to": {
    "date": "2024-01-31T23:59:59.999Z",
    "timezone": "UTC"
  }
}
'
{
  "success": true,
  "data": {
    "filePath": "agents-usage/workspace-id/agents-usage-2024-01-01-2024-01-31-abc12345.csv",
    "downloadUrl": "https://storage.example.com/signed-url",
    "dataType": "assistants",
    "recordCount": 1250,
    "dateRange": {
      "from": "2024-01-01T00:00:00.000Z",
      "to": "2024-01-31T23:59:59.999Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.langdock.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint exports user activity data including message counts, usage patterns, and feature utilization. The available data depends on your workspace privacy settings.
Using a dedicated deployment?Replace api.langdock.com with <your-deployment>/api/public in all requests.

Privacy Considerations

The user export data is subject to workspace privacy settings, user-identifying data may be excluded due to privacy settings. As a consequence of this some data may be anonymized based on workspace configuration.

Data Included

The user export may contain:
  • Message count per user
  • Activity patterns
  • Usage frequency
  • Feature utilization
  • Time-based usage analytics
  • Token consumption and cost per user (BYOK workspaces only)
  • Per-model token and cost breakdown (BYOK workspaces only)
Because BYOK workspaces supply their own model keys, Langdock can provide token consumption and costs directly. This is not possible when obtaining your models directly through Langdock.
For details on prerequisites, rate limits, and export size limits, please refer to the main Usage Export API documentation.
Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.

Authorizations

Authorization
string
header
required

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json

Request body for usage export endpoints

from
object
required

Start date and timezone for the export

to
object
required

End date and timezone for the export

Response

Export successful

Successful response from usage export endpoints

success
boolean
required

Indicates if the export was successful

Example:

true

data
object
required

Export data information