Skip to main content
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.
Authentication Requirement: This endpoint requires a service token (company-level), not a data app API key. Service tokens have elevated permissions. Use the token that has access to the workspace and dashboard.

Authentication

Use your service token in the Authorization 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"
The response body is a JSON object with this structure:
object
Metadata about the export.
string
ISO 8601 timestamp when the export was performed.
string
The workspace name the dashboard was exported from.
string
The dashboard ID that was exported.
object
The dashboard configuration and content (layout, metrics, filters, etc.). Structure matches what the import API expects as importDashboardData.
On error, the API returns a JSON error object (e.g. 400 or 500) with error.code and error.message.

Examples

HTTP Status Code Summary

Possible Errors