Skip to main content
POST
/
api
/
public
/
export
/
workflows
Export workflow usage data
curl --request POST \
  --url https://api.langdock.com/api/public/export/workflows \
  --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"
  }
}'
{
  "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"
    }
  }
}
This endpoint exports workflow usage data including execution counts, success rates, and performance metrics. It’s only available if workflows are enabled in your workspace.
Note: This endpoint will return no data if workflows are not enabled in your workspace. Contact your workspace administrator to enable workflows if needed.

Data Included

The workflow export contains:
  • Workflow executions
  • Success rates
  • Performance metrics
  • Error rates and types
  • Execution duration statistics
  • Resource consumption
Additional Information: For details on prerequisites, rate limits, and export size limits, please refer to the main Usage Export API documentation.

Headers

Authorization
string
required

API key as Bearer token with USAGE_EXPORT_API scope. 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

I