Get an embeddable dashboard

GET /v1/embed/dashboard/{publicId}

Get an embeddable dashboard

cURL

curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId} \
  --header 'Authorization: Bearer <token>'

200

{
  "allowEmbed": true,
  "config": {
    "description": "<string>",
    "layout": {
      "breakpoints": {
        "lg": 123,
        "md": 123,
        "sm": 123,
        "xs": 123,
        "xxs": 123
      },
      "cols": {
        "lg": 123,
        "md": 123,
        "sm": 123,
        "xs": 123,
        "xxs": 123
      },
      "containerPadding": [
        123
      ],
      "margin": [
        123
      ],
      "rowHeight": 123
    },
    "settings": {},
    "theme": {},
    "title": "<string>",
    "widgets": [
      {
        "id": "<string>",
        "position": {
          "h": 123,
          "w": 123,
          "x": 123,
          "y": 123
        },
        "config": {},
        "responsiveLayouts": {
          "lg": {
            "h": 123,
            "w": 123,
            "x": 123,
            "y": 123
          },
          "md": {
            "h": 123,
            "w": 123,
            "x": 123,
            "y": 123
          },
          "sm": {
            "h": 123,
            "w": 123,
            "x": 123,
            "y": 123
          },
          "xs": {
            "h": 123,
            "w": 123,
            "x": 123,
            "y": 123
          },
          "xxs": {
            "h": 123,
            "w": 123,
            "x": 123,
            "y": 123
          }
        },
        "style": {}
      }
    ]
  },
  "deploymentId": 123,
  "id": 123,
  "publicId": "<string>",
  "reportSnapshots": [
    {
      "id": 123,
      "reportId": 123,
      "versionNumber": 123,
      "description": "<string>",
      "meta": {},
      "name": "<string>",
      "preferences": {
        "columnFormats": {}
      },
      "spec": "<string>",
      "sqlQuery": "<string>",
      "title": "<string>"
    }
  ],
  "versionId": 123,
  "versionNumber": 123,
  "workbookId": 123,
  "createdBy": 123,
  "description": "<string>",
  "title": "<string>"
}

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

Show child attributes

deploymentId · integer · required

id · integer · required

publicId · string · required

reportSnapshots · object[] · required

Show child attributes

status · enum<string> · required

Available options: draft, published, archived

versionId · integer · required

versionNumber · integer · required

workbookId · integer · required

createdBy · integer | null

description · string | null

title · string | null