Embed

Get an embeddable dashboard

Changed on
get/api/v1/embed/dashboard/{publicId}

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/embed/dashboard/{publicId}
  • Auth: HTTP bearer

Path parameters

publicIdstring required

Response

allowEmbedboolean required
createdByinteger nullable
deploymentIdinteger required
descriptionstring nullable
fromSharedWorkspaceboolean nullable
idinteger required
publicIdstring required
restrictDataDownloadboolean nullable
status'draft' | 'published' | 'archived' required
titlestring nullable
useBoardDashboardsboolean nullable
versionIdinteger required
versionNumberinteger required
workbookIdinteger required

Changes

  • 04b88ae6ce37Revision changes
    • info

      added the optional property // to the response with the status

  • 914d24830bb3Revision changes
    • warning

      added the new FIELD enum value to the //// response property for the response status