Skip to main content

Published Dashboard

View as Markdown

PublishedDashboard object​

display_namestringOutput only

The display name of the published dashboard.

Example: Monthly Traffic Report

warehouse_idstring

The ID of the SQL warehouse that runs the published dashboard's queries. It is the warehouse given when the dashboard was published, or the draft's warehouse if none was given.

Example: 47bb1c472649e711

embed_credentialsboolean

Whether the publisher's credentials are embedded in the published dashboard. When true, viewers run the dashboard's queries with the publisher's data permissions (shared data permissions); when false, each viewer runs them with their own data permissions.

revision_create_timestringOutput only

The timestamp of when the current published version was created, that is, when the dashboard was last published.

Get published dashboard GA​

GET /api/2.0/lakeview/dashboards/{dashboard_id}/published

Get the current published dashboard. The request fails with NOT_FOUND if the dashboard has never been published or has been unpublished.

The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.

Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.

API scopes: dashboards

Parameters​

dashboard_idstringRequiredpath

UUID identifying the published dashboard.

Response​

Returns the PublishedDashboard object.

Unpublish dashboard GA​

DELETE /api/2.0/lakeview/dashboards/{dashboard_id}/published

Unpublish the dashboard. This deletes the published version, so viewers can no longer open it, and pauses the dashboard's schedules. The draft is not changed; publish it again to make the dashboard available to viewers.

API scopes: dashboards

Parameters​

dashboard_idstringRequiredpath

UUID identifying the published dashboard.

Revert dashboard GA​

POST /api/2.0/lakeview/dashboards/{dashboard_id}/revert

Revert a dashboard's definition in draft mode to the last published version. The draft's datasets, pages and widgets are replaced with those of the current published version, and the updated draft is returned. The dashboard must have been published at least once; the published version itself is not changed.

API scopes: dashboards

Parameters​

dashboard_idstringRequiredpath

UUID identifying the dashboard.

Request body​

etagstring

The etag of the draft dashboard, as returned by the get dashboard API. When provided, the request fails with ABORTED if the draft has been modified since that etag was read.

Example: 80611980

Response​

dashboardobject

The reverted dashboard.

Show child attributesHide child attributes
dashboard_idstringOutput only

UUID identifying the dashboard.

Example: 04aab30f99ea444490c10c85852f216c

display_namestring

The display name of the dashboard. It is also the file name of the dashboard asset in the workspace, so it must be unique within the parent folder, cannot contain /, and cannot end with .json, .lvdash or .yml. The display name must not exceed 500 characters.

Example: Monthly Traffic Report

pathstringOutput only

The workspace path of the dashboard asset, including the file name. Exported dashboards always have the file extension .lvdash.json. This field is excluded in List Dashboards responses.

Example: /path/to/dir/Monthly Traffic Report.lvdash.json

create_timestringOutput only

The timestamp of when the dashboard was created.

update_timestringOutput only

The timestamp of when the dashboard was last updated by the user. This field is excluded in List Dashboards responses.

warehouse_idstring

The warehouse ID used to run the dashboard.

Example: 47bb1c472649e711

etagstring

The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard has not been modified since the last read. This field is excluded in List Dashboards responses.

Example: 80611980

serialized_dashboardstring

The dashboard definition (datasets, pages and widgets) as a JSON string, in the same format as a dashboard file exported from the workspace (.lvdash.json). When omitted on create, an empty dashboard is created; when omitted on update, the existing definition is kept and only the other fields change. Use the get dashboard API on an existing dashboard to see a complete example. This field is excluded in List Dashboards responses.

lifecycle_statestringOutput only

The state of the dashboard resource. Used for tracking trashed status.

Values:

  • ACTIVE
  • TRASHED
parent_pathstringImmutable

The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. The folder must already exist; when omitted on create, the dashboard is created in the caller's home folder. This field is excluded in List Dashboards responses.

Example: /path/to/dir

Read information of a published dashboard to mint an OAuth token Public Preview​

GET /api/2.0/lakeview/dashboards/{dashboard_id}/published/tokeninfo

Get the OAuth scope and authorization details needed to mint a token that is scoped to viewing the published dashboard, for example to embed it in an external application. Pass the response fields, with authorization_details serialized as a JSON string, to the workspace OAuth token endpoint with the client_credentials grant to mint the token. See Embedding for external users.

The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.

Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.

API scopes: dashboards

Parameters​

dashboard_idstringRequiredpath

UUID identifying the published dashboard.

external_valuestringquery

Value to carry in the token for this viewer, such as a tenant or region key. Dashboard dataset queries can reference it as __aibi_external_value to filter data per viewer. The combined size of external_value and external_viewer_id must be less than 1 KB.

external_viewer_idstringquery

Identifier of the viewer in the external application. It is recorded in dashboard audit logs, so it should be unique per viewer and must not contain personally identifiable information.

Response​

custom_claimstring

Custom claim that carries external_value and external_viewer_id into the minted token. It is only present when at least one of those query parameters was provided. Format: urn:aibi:external_data:<external_value>:<external_viewer_id>:<dashboard_id>

scopestring

The space-separated OAuth scopes to request when minting the token.

authorization_detailsarray of object

Authorization constraints that restrict the minted token to viewing the published dashboard. Pass them to the OAuth token endpoint serialized as a JSON array.

Show child attributesHide child attributes
typestring

The type of authorization downscoping policy. A workspace_rule_set policy defines access rules for a specific workspace resource.

resource_namestring

The resource name to which the authorization rule applies. This field is specific to the workspace_rule_set constraint. Format: workspaces/{workspace_id} for a workspace-level rule, or workspaces/{workspace_id}/dashboards/{dashboard_id} for a rule on a dashboard.

resource_legacy_acl_pathstring

The legacy ACL path of the workspace object that the rule applies to.

grant_rulesarray of object

Represents downscoped permission rules with specific access rights. This field is specific to the workspace_rule_set constraint.

Show child attributesHide child attributes
permission_setstring

The permission set that the rule grants on the resource.

Example: permissionSets/dashboard.runner