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)
| Task | Endpoint |
|---|---|
| Create a data app | POST /api/v2/data-app |
| List data apps | GET /api/v2/data-app |
| Update a data app | PUT /api/v2/data-app |
| Delete a data app | DELETE /api/v2/data-app |
API tokens
| Task | Endpoint | Token |
|---|---|---|
| Create an API token | POST /api/v2/data-app/api-tokens | Service token |
| List API tokens | GET /api/v2/data-app/api-tokens | Service token |
| Rotate an API token | POST /api/v2/data-app/rotate-api | The data app API token itself |
Data retrieval
| Task | Endpoint | Token |
|---|---|---|
| Fetch dashboards by data app | GET /api/v2/data-app/dashboards | Data app API token |
| Fetch metrics by embed | GET /api/v2/data-app/metrics | Data app API token |
| Query a metric | POST /api/v2/data-app/query | Either |
| Download a dashboard as PDF | POST /api/v2/data-app/getDashboardPdf | Either |
| Ask a question | POST /api/v2/data-app/ask | Service token |
| Preview a chart | POST /api/v2/data-app/chart-preview | Service token |
| Export a dashboard | POST /api/v2/data-app/export-dashboard | Service token |
| Import a dashboard | POST /api/v2/data-app/import-dashboard | Service token |
| Promote a dashboard | POST /api/v2/data-app/dashboard-releases | Service token |
| List dashboard releases | GET /api/v2/data-app/dashboard-releases | Service token |
| Roll back a release | POST /api/v2/data-app/dashboard-releases/rollback | Service 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.