Skip to main content
GET
Get an embeddable dashboard
Returns the dashboard identified by its publicId — including its reports/widgets — resolved within the caller’s embed session scope, for rendering inside an embedded view. Access is authorized against the embed user: the dashboard is returned when the user owns its workbook, has been granted workbook access (folder-based or direct), holds EmbedDashboardRead on the dashboard, or when it has been shared with all embed users (creator-mode flow). Returns 404 if the dashboard does not exist or is not visible to the caller. Signed embedding additionally requires the dashboard to have “Allow signed embedding” enabled; the trusted screenshoter and creator-mode session flows are exempt. Returns 403 when embedding is not permitted for the dashboard.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

publicId
string
required

Response

200 - application/json
allowEmbed
boolean
required
config
object
required
deploymentId
integer
required
id
integer
required
publicId
string
required
reportSnapshots
object[]
required
status
enum<string>
required
Available options:
draft,
published,
archived
versionId
integer
required
versionNumber
integer
required
workbookId
integer
required
createdBy
integer | null
description
string | null
fromSharedWorkspace
boolean | null
restrictDataDownload
boolean | null
title
string | null
useBoardDashboards
boolean | null