{"openapi":"3.1.0","info":{"title":"POST /api/v1/dashboards/{dashboard_id}/export","version":"1.0.0","description":"Export a dashboard to CSV or PDF"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/dashboards/{dashboard_id}/export":{"post":{"tags":["dashboards"],"summary":"Export a dashboard to CSV or PDF","description":"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.\n\nExports 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.","operationId":"export_dashboard_api_v1_dashboards__dashboard_id__export_post","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","title":"Dashboard Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportDashboardRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_DashboardExportResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DashboardExportResponse":{"properties":{"task_id":{"type":"string","title":"Task Id"},"status":{"type":"string","title":"Status"},"dashboard_id":{"type":"string","title":"Dashboard Id"},"output_format":{"type":"string","enum":["csv","pdf"],"title":"Output Format"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"additionalProperties":false,"type":"object","required":["task_id","status","dashboard_id","output_format"],"title":"DashboardExportResponse","description":"Accepted-export handle; poll the report task-status endpoint with it."},"ExportDashboardRequest":{"properties":{"output_format":{"type":"string","enum":["csv","pdf"],"title":"Output Format","default":"pdf"},"widget_ids":{"items":{"type":"string"},"type":"array","maxItems":24,"title":"Widget Ids"},"include_empty":{"type":"boolean","title":"Include Empty","description":"Include widgets that have no snapshot data.","default":false}},"additionalProperties":false,"type":"object","title":"ExportDashboardRequest","description":"Body for ``POST /dashboards/{dashboard_id}/export``.\n\nExports read **stored snapshots only** — they never re-execute widget\nsources. A dashboard can hold up to 24 tool-backed widgets, so exporting\nlive would turn one click into 24 analytical queries; use the refresh\nendpoints (or a schedule) first if fresher data is wanted."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_DashboardExportResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/DashboardExportResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[DashboardExportResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}