Export a dashboard to CSV or PDF

POST/api/v1/dashboards/{dashboard_id}/export

Queue an asynchronous export of this dashboard and return a task id. Poll the standard report task-status endpoint (GET /api/v1/task/{task_id}) for progress and the download link — this reuses the report pipeline rather than adding a second one.

Exports read stored snapshots only and never re-execute widget sources, so an export is exactly as fresh as the dashboard and costs no analytical queries. Charts are flattened to their underlying tabular data: CSV emits one section per widget, PDF renders those same tables. No chart images are rendered server-side.

Operation ID: export_dashboard_api_v1_dashboards__dashboard_id__export_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

dashboard_idstringrequired

Request body

Schema: ExportDashboardRequest

output_formatstring: One of: csv, pdf
widget_idsarray · string
include_emptyboolean: Include widgets that have no snapshot data.

Responses

201Successful Response

Schema: SuccessEnvelope_DashboardExportResponse_

successboolean
messagestring
codestring
dataDashboardExportResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/dashboards/{dashboard_id}/export

bash

curl -X POST 'https://api.ondayzero.com/api/v1/dashboards/{dashboard_id}/export' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "output_format": "csv",
  "widget_ids": [],
  "include_empty": false
}'