IMimprovado
Dashboards

List embeddable Dashboards

Return IDs and titles of registered React Dashboards accessible to the API user in the selected workspace. Public sharing does not need to be enabled. Dashboard configuration, creator identities, file paths and access tokens are not returned.

Use a returned dashboard_id with POST /api/v3/dashboards/{dashboard_id}/embed-session/. Listing a dashboard does not grant access to your application's viewers; authorize each viewer on your backend before issuing a temporary URL.

Pagination follows catalog pages before unsupported entries are filtered out. A page may contain fewer than page_size items, or be empty while next_page is set. Continue requesting next_page with the same workspace_id and page_size until it is null. No total count of embeddable dashboards is returned.

get/api/v3/dashboards/embeddable/

Request

Query parameters

workspace_idinteger required

Workspace accessible to the authenticated API user.

pageinteger

Catalog page to request. Start at 1 and follow next_page.

page_sizeinteger

Number of catalog entries considered before filtering unsupported entries.

Response

Accessible Dashboards on this catalog page.

next_pageinteger nullable required

Next catalog page to request, or null when no more pages remain. Follow even if items is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.