Skip to main content
GET
Get a comprehensive list of all embed configurations created by your data app, including both dashboard and metric embeds with their associated metadata.
Endpoint Migration Notice: We’re transitioning to kebab-case endpoints. The new endpoint is /api/v2/data-app/embeds. The old endpoint /api/v2/dataApp/embeds will be deprecated soon. Please update your integrations to use the new endpoint format.
This endpoint returns all embeds you have access to within the authenticated data app. The response includes embed IDs, types, and associated dashboard/metric information.

Endpoint Formats

Authentication

All API requests must include your API key in the Authorization header. Get your API token when creating a data app - see our data app creation guide for details. Finding your API token: For detailed instructions, see the API Token guide.

Headers

string
required
Bearer token for API authentication. Use your API key from the data app.

Query Parameters

string
Whether to paginate results. Pass "true" to enable pagination with a limit of 10 per page.Note: Query parameters are passed as strings. Use "true" or "false".
string
Page number to retrieve (1-based). Only used when isPagination is "true". Must be a numeric string (e.g., "1", "2").
string
Optional client ID to filter embeds. When provided, only returns dashboard embeds where the dashboard was created by the specified client.

Response

array
Array of embed objects with their configuration details.
string
Unique identifier for the embed configuration.
string
Type of embed: “dashboard” or “metric”.
string
The human-readable name of the embed configuration. This is the name set when creating or renaming the embed configuration.
object | null
Dashboard information (present when embedType is “dashboard”, null otherwise).
string
Unique identifier for the external dashboard.
object
Dashboard metadata information.
string
Name of the dashboard.
object | null
Metric information (present when embedType is “metric”, null otherwise).
string
Unique identifier for the external metric.
string
Name of the metric.
object
Consolidated metadata object containing key embed information for easy access.
string
Unique identifier for the embed configuration.
string
The human-readable name of the embed configuration.
string
Type of embed: “dashboard” or “metric”.
string
Name of the data app associated with this embed.
string | null
Unique identifier for the metric (present when embedType is “metric”, null otherwise).
string | null
Unique identifier for the dashboard (present when embedType is “dashboard”, null otherwise).
string
ISO 8601 formatted timestamp indicating when the embed configuration was created.
string
ISO 8601 formatted timestamp indicating when the embed configuration was last updated.
null
Error field, null when successful. Not included in successful responses.

Examples

Error Codes

Quick Start Guide

1

Get your API token

For detailed instructions, see the API Token guide.
2

List all embed configurations

Get all your embed configurations:
Note: You can add query parameters for pagination or filtering if needed.
3

Use pagination for many embeds

If you have many embed configurations, use pagination with query parameters:
4

Manage your embeds

Use the embed information to manage your configurations:

Next Steps

Embed a Pre-built Dashboard/Metric

Learn how to create new embed configurations

Update an Embed

Modify existing embed access settings

Delete an Embed

Remove embed configurations you no longer need

Query Metrics API

Query data from your embedded metrics