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.
To deploy a revision to an existing dashboard ID, pass the export’s
On error, the API returns a JSON error object (e.g. 400 or 500) with
data object to the import API with mode: "replace". Export the target dashboard first as a backup. See Replace dashboard contents for replacement rules and limits.
Authentication
Use your service token in theAuthorization header. See Create Service Token for how to obtain a service token.
Headers
Request Body
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).
Optional workspace name to include in the export metadata. The dashboard itself is resolved from
dashboardId within the service-token company.Optional non-empty client ID. When supplied, the export uses that client’s saved dashboard layout and client-specific metric visibility. Databrain trims the value and verifies that the client belongs to the dashboard’s workspace.If omitted, the dashboard owner’s client context is used when available. Otherwise, the base dashboard layout is exported.
An invalid
sourceClientId, including a client that does not belong to the dashboard workspace, returns CLIENT_ID_ERROR.Response
On success, the API returns 200 with:- Content-Type:
application/json - Content-Disposition:
attachment; filename="dashboard-{dashboardId}.json"
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

