Export User Usage

This endpoint exports user activity data including message counts, usage patterns, and feature utilization. The available data depends on your workspace privacy settings.

POST https://api.langdock.com/export/users

Try it

Example request (cURL)

curl --request POST \
  --url https://api.langdock.com/export/users \
  --header 'Authorization: <authorization>' \
  --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"
  }
}
'

Example response (200)

{
  "success": true,
  "data": {
    "filePath": "assistants-usage/workspace-id/assistants-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"
    }
  }
}

Status codes: 200, 400, 401, 404

---

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, 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

Note: User-specific data may be excluded due to workspace privacy settings.

Additional information (prerequisites, rate limits, export size limits): see the main Usage Export API documentation: https://docs.langdock.com/api-endpoints/usage-export/intro-to-usage-export-api

---

Headers

Authorization (string, required) API key as Bearer token with USAGE_EXPORT_API scope. Format: "Bearer YOUR_API_KEY"

Content-Type: application/json

---

Body (application/json)

Request body for usage export endpoints.

from (object, required) — Start date and timezone for the export

• from.date (string, required) — Start date in ISO 8601 format Example: "2024-01-01T00:00:00.000Z"

• from.timezone (string, required) — Timezone for the date range Example: "UTC"

to (object, required) — End date and timezone for the export

• to.date (string, required) — End date in ISO 8601 format Example: "2024-01-31T23:59:59.999Z"

• to.timezone (string, required) — Timezone for the date range Example: "UTC"

---

Response (200 application/json)

Export successful.

Response fields:

• success (boolean, required) — Indicates if the export was successful. Example: true

• data (object, required) — Export data information:

  • data.filePath (string, required) — Path to the generated export file Example: "assistants-usage/workspace-id/assistants-usage-2024-01-01-2024-01-31-abc12345.csv"

  • data.downloadUrl (string, required) — Signed URL to download the export file Example: "https://storage.example.com/signed-url"

  • data.dataType (enum, required) — Type of data exported. Available options: assistants, users, workflows, projects, models Example: "assistants"

  • data.recordCount (integer, required) — Number of records in the export. Example: 1250

  • data.dateRange (object, required) — Actual date range of the exported data

---