Skip to main content
GET
Fetch all dashboards associated with your data app. This endpoint allows you to discover available dashboards for embedding or integration purposes, with support for filtering by dashboard names and pagination.
API Method Migration Notice: We’re transitioning from POST to GET for this endpoint. The new GET method is recommended for all new integrations. The POST method will be deprecated soon.
This endpoint returns dashboards that have been configured for your data app. Use the dashboard information to create embed configurations or for display purposes.

API Methods

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

Authorization
string
required
Bearer token for API authentication. Use your API key from the data app.
Content-Type
string
Required only for POST method. Must be set to application/json.

Query Parameters

isPagination
string
required
Enable pagination to limit the number of results returned. Pass "true" to enable pagination with a limit of 10 per page.Note: Query parameters are passed as strings. Use "true" or "false".
pageNumber
string
required
Page number for pagination (1-based). Only used when isPagination is "true". Must be a numeric string (e.g., "1", "2").
dashboardNames
string
Comma-separated list of dashboard names to filter by. Only dashboards with matching names will be returned.Example: "Sales Dashboard,Marketing Analytics,Customer Insights"

Examples

Legacy Endpoint Examples

The following examples use the deprecated POST method. These are provided for reference only. Please use the GET method examples above for all new integrations.

POST Method (Legacy - Being Deprecated)

Request Body (POST)

isPagination
boolean
Enable pagination to limit the number of results returned. When enabled, use pageNumber to navigate through pages.
pageNumber
number
Page number for pagination (1-based). Only used when isPagination is true. Each page returns up to 10 dashboards.
filters
object
Optional filters to narrow down the dashboard results.
filters.dashboardNames
array
Array of specific dashboard names to filter by. Only dashboards with matching names will be returned.
Example

POST Examples

Response (Success 200)

data
array
Array of dashboard objects available in your data app.
data.name
string
Display name of the dashboard.
data.externalDashboardId
string
Unique identifier for the dashboard that can be used in embed configurations.
data.embedId
string
Embed ID associated with this dashboard, if available.

Error Response

error
object
Error object returned only when the request fails. Not included in successful responses.
error.code
string
Error code identifier.
error.message
string
Human-readable error message.

Error Codes

INVALID_DATA_APP_API_KEY
string
Invalid or missing Data App API Key - Check your API key and ensure it’s valid for your data app
INVALID_REQUEST_BODY
string
Invalid request parameters - Verify that your request body contains valid field types

HTTP Status Code Summary

Possible Errors

Pagination Guide

When using pagination:
  1. Enable pagination by setting isPagination to true (GET) or true (POST)
  2. Start with page 1 using pageNumber=1 (GET) or pageNumber: 1 (POST)
  3. Each page returns up to 10 dashboards
  4. Continue to next page if you receive exactly 10 results
  5. Stop pagination when you receive fewer than 10 results

GET Method Pagination Example:

POST Method Pagination Example:

Filtering Options

Dashboard Name Filtering

GET Method: Use comma-separated values in query parameter
POST Method: Use array in request body
This is useful when you know the exact dashboard names you want to work with.

Migration Guide: POST to GET

If you’re currently using the POST method, here’s how to migrate to GET:

Before (POST):

After (GET):

Key Differences:

  1. Method: POST → GET
  2. Parameters: Request body → Query parameters
  3. Boolean values: true"true" (string in query params)
  4. Number values: 1"1" (string in query params)
  5. Dashboard names: Array ["name1", "name2"] → Comma-separated string "name1,name2"
  6. Content-Type header: Not needed for GET

Quick Start Guide

1

Get your API token

For detailed instructions, see the API Token guide.
2

List all dashboards (GET - Recommended)

Get all dashboards available in your data app:
3

Filter by specific dashboard names

If you’re looking for specific dashboards, use query parameters:
4

Use dashboard information for embedding

Process the dashboard data to create embed configurations:

Next Steps

Embed a Pre-built Dashboard/Metric

Use dashboard IDs to create embed configurations

Fetch Metrics by Embed

Get metrics available for specific embedded dashboards

Query Metric Data

Query data from your dashboard metrics

Guest Token API

Generate secure tokens for embedded access