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.
| Task | Endpoint |
|---|---|
| Embed a dashboard or metric | POST /api/v2/data-app/embeds |
| Create a customer dashboard embed | POST /api/v2/data-app/dashboard-embeds |
| List embeds | GET /api/v2/data-app/embeds |
| Update access settings | PUT /api/v2/data-app/embeds |
| Rename an embed | PUT /api/v2/data-app/embeds/rename |
| Delete an embed | DELETE /api/v2/data-app/embeds |
| Export an embedded dashboard | GET /api/v2/data-app/embeds/export |
| List scheduled reports | GET /api/v2/data-app/embeds/reports |
| Delete a scheduled report | DELETE /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 route | Use instead | Difference |
|---|---|---|
POST /api/v2/data-app/embed/create | POST /embeds | Returns only id |
POST /api/v2/data-app/dashboardEmbed/create | POST /dashboard-embeds | JSON only, no file upload. Returns no name |
POST /api/v2/data-app/embed/update | PUT /embeds | None |
POST /api/v2/data-app/embed/delete | DELETE /embeds | embedId in the body. Cannot delete the dashboard |
POST /api/v2/data-app/embed/list | GET /embeds | Paging and clientId in the body |
The path /api/v2/dataApp/... is the same API as /api/v2/data-app/....
Next, embed a dashboard.