Skip to main content

Usage Dashboards

View as Markdown

Create new usage dashboard GA​

POST /api/2.0/accounts/{account_id}/dashboard

Imports a pre-built usage dashboard of the given type into a workspace. Each call imports a new dashboard, even if the caller already created one of the same type in that workspace. The caller must be an account admin and a user of the target workspace. See https://docs.databricks.com/admin/account-settings/usage.html.

API scopes: billing

Parameters​

account_idstringRequiredpath

<Databricks> account ID.

Request body​

workspace_idint64

The ID of the workspace to import the usage dashboard into. The workspace must be running, belong to the account, and not be a disaster recovery secondary.

dashboard_typestring

Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account. The request fails if the type is not set.

Values:

  • USAGE_DASHBOARD_TYPE_WORKSPACE
  • USAGE_DASHBOARD_TYPE_GLOBAL
major_versionstring

The major version of the usage dashboard template to import. Version 2 adds cost forecasting and object-level cost drill-down.

Default: USAGE_DASHBOARD_MAJOR_VERSION_1

Values:

  • USAGE_DASHBOARD_MAJOR_VERSION_1
  • USAGE_DASHBOARD_MAJOR_VERSION_2

Response​

dashboard_idstring

The ID of the AI/BI dashboard that was created.

Get usage dashboard GA​

GET /api/2.0/accounts/{account_id}/dashboard

Gets the most recent usage dashboard of the given type that the caller created. The response is empty if no such dashboard exists, if it has been deleted, or if the caller can no longer access its workspace.

API scopes: billing

Parameters​

account_idstringRequiredpath

<Databricks> account ID.

workspace_idint64query

The ID of the workspace that contains the usage dashboard. If omitted, the most recently created dashboard of the given type across all workspaces in the account is returned.

dashboard_typestringquery

Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account. The request fails if the type is not set.

Values:

  • USAGE_DASHBOARD_TYPE_WORKSPACE
  • USAGE_DASHBOARD_TYPE_GLOBAL

Response​

dashboard_idstring

The ID of the AI/BI dashboard. The ID is empty if no matching dashboard is found.

dashboard_urlstring

The URL of the dashboard in its workspace. The URL is empty if no matching dashboard is found.