Skip to Content

Data App APIs

Data app APIs

Manage data apps, their API tokens, and read the dashboards, metrics and data they embed.

A data app groups the embeds that one of your products shows. Each data app has its own API tokens, which your backend uses to create guest tokens.

Data app CRUD (service token)

TaskEndpoint
Create a data appPOST /api/v2/data-app
List data appsGET /api/v2/data-app
Update a data appPUT /api/v2/data-app
Delete a data appDELETE /api/v2/data-app

API tokens

TaskEndpointToken
Create an API tokenPOST /api/v2/data-app/api-tokensService token
List API tokensGET /api/v2/data-app/api-tokensService token
Rotate an API tokenPOST /api/v2/data-app/rotate-apiThe data app API token itself

Data retrieval

TaskEndpointToken
Fetch dashboards by data appGET /api/v2/data-app/dashboardsData app API token
Fetch metrics by embedGET /api/v2/data-app/metricsData app API token
Query a metricPOST /api/v2/data-app/queryEither
Download a dashboard as PDFPOST /api/v2/data-app/getDashboardPdfEither
Ask a questionPOST /api/v2/data-app/askService token
Preview a chartPOST /api/v2/data-app/chart-previewService token
Export a dashboardPOST /api/v2/data-app/export-dashboardService token
Import a dashboardPOST /api/v2/data-app/import-dashboardService token
Promote a dashboardPOST /api/v2/data-app/dashboard-releasesService token
List dashboard releasesGET /api/v2/data-app/dashboard-releasesService token
Roll back a releasePOST /api/v2/data-app/dashboard-releases/rollbackService token

See Authentication for the two kinds of token. Creating a data app or an API token needs embedding on your plan.

The path /api/v2/dataApp/... is the same API as /api/v2/data-app/....

Next, create a data app.

On this page