Data Retrieval
Export Dashboard
Export a dashboard from a workspace as a JSON file for backup, migration, or import into another workspace.
POST
Export a dashboard and its configuration (layout, metrics, filters) from a workspace. The response is a JSON file download that can be used with the Import Dashboard API or the UI import flow.
On error, the API returns a JSON error object (e.g. 400 or 500) with
Authentication
Use your service token in theAuthorization header. See Create Service Token for how to obtain a service token.
Headers
string
required
Bearer token for API authentication. Use your service token (company-level).
string
required
Must be
application/json when sending a JSON body.Request Body
string
required
The dashboard ID to export. This is the external dashboard ID (e.g. from Fetch Dashboards by Data App or the dashboard list in the UI).
string
required
The name of the workspace that contains the dashboard. Must match the workspace name exactly.
Response
On success, the API returns 200 with:- Content-Type:
application/json - Content-Disposition:
attachment; filename="dashboard-{dashboardId}.json"
object
object
The dashboard configuration and content (layout, metrics, filters, etc.). Structure matches what the import API expects as
importDashboardData.error.code and error.message.
Examples
HTTP Status Code Summary
Possible Errors
Related
- Import Dashboard – Import a previously exported dashboard into a workspace
- Fetch Dashboards by Data App – List dashboards to get
dashboardIdvalues - Import/Export Dashboard (UI) – UI guide for import/export

