Skip to Content

Embeds

Embed APIs

Create, change and remove the dashboards and metrics that a data app embeds.

An embed puts one dashboard or metric of a workspace into a data app, with the access settings your customers get. Your app then shows it with a guest token.

TaskEndpoint
Embed a dashboard or metricPOST /api/v2/data-app/embeds
Create a customer dashboard embedPOST /api/v2/data-app/dashboard-embeds
List embedsGET /api/v2/data-app/embeds
Update access settingsPUT /api/v2/data-app/embeds
Rename an embedPUT /api/v2/data-app/embeds/rename
Delete an embedDELETE /api/v2/data-app/embeds
Export an embedded dashboardGET /api/v2/data-app/embeds/export
List scheduled reportsGET /api/v2/data-app/embeds/reports
Delete a scheduled reportDELETE /api/v2/data-app/embeds/reports

Before you start

  • You have a data app API token for the data app. These endpoints act on the data app of the token. A service token gets 400 INVALID_DATA_APP_API_KEY. See Authentication.
  • Creating or updating an embed needs embedding on your plan. Listing, renaming, exporting and deleting always work.

Older routes

These still work, with the same rules:

Older routeUse insteadDifference
POST /api/v2/data-app/embed/createPOST /embedsReturns only id
POST /api/v2/data-app/dashboardEmbed/createPOST /dashboard-embedsJSON only, no file upload. Returns no name
POST /api/v2/data-app/embed/updatePUT /embedsNone
POST /api/v2/data-app/embed/deleteDELETE /embedsembedId in the body. Cannot delete the dashboard
POST /api/v2/data-app/embed/listGET /embedsPaging and clientId in the body

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

Next, embed a dashboard.

On this page