Export an analytics tab
Export the selected analytics tab and filters as a UTF-8 CSV attachment. Topics exports require an agent and accept only agent and branch filters.
Endpoint
GET
/api/v1/workspaces/{workspace_id}/analytics/tabs/{tab}/exportAuthentication
| Operation class | Authentication | Minimum role | API key |
|---|---|---|---|
| customer-api | Bearer API key or dashboard session cookie; dashboard mutations also require X-CX-Request: 1. | member | Allowed |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
workspace_id | path | string | Yes | — |
tab | path | string | Yes | — |
from | query | string or null | No | — |
to | query | string or null | No | — |
timezone | query | string or null | No | — |
granularity | query | string or null | No | — |
agent_id | query | string or null | No | — |
branch_id | query | string or null | No | — |
version_id | query | string or null | No | — |
source | query | string or null | No | — |
group_by | query | string or null | No | — |
Request body
This operation has no request body.
Example
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/analytics/tabs/general/export?granularity=day' \ --header 'Authorization: Bearer YOUR_API_KEY' \ --output analytics.csv
Responses
| Status | Description | Content |
|---|---|---|
4XX | Client Error | application/json: ErrorResponse |
200 | A UTF-8 CSV export. | text/csv: string |
4XX application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | ErrorResponse | — | No | Yes | — | — |
error | object | ErrorItem | — | No | Yes | — | — |
error.code | string | — | — | No | Yes | — | — |
error.details | object | — | — | No | No | — | — |
error.message | string | — | — | No | Yes | — | — |
200 text/csv response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | string | — | — | No | Yes | — | — |
Response example
"section,name,value,denominator\r\n"
Errors
Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.
| Status | Code | Description |
|---|---|---|
401 | unauthenticated | Authentication is missing, invalid, or revoked. |
403 | forbidden | The authenticated caller does not have access to this operation. |
404 | not_found | The requested workspace resource was not found. |
422 | validation_failed | The analytics window, filter combination, tab, grouping, or requested resource is invalid. |