Embedding API
Workspace content APIs
Find the dashboards and metrics of a workspace, so you can embed them.
These endpoints read what a workspace holds. Use the ids they return to create an embed or to update workspace dashboards.
| Task | Endpoint | Returns |
|---|---|---|
| Fetch dashboards by workspace | POST /api/v2/workspace/dashboards | externalDashboardId of each dashboard |
| Fetch metrics by workspace | POST /api/v2/workspace/metrics | metricId of each metric |
| Fetch metrics by dashboard | POST /api/v2/workspace/dashboard/metrics | metricId of each metric on one dashboard |
Before you start
You have a service token. See Authentication.
Workspaces are named by workspaceName everywhere. The lists include dashboards and metrics that your customers made in their embeds.