Skip to main content

Refresh Databricks Dashboard

Refreshes the underlying data of an AI/BI (Lakeview) dashboard by submitting a one-time Databricks Job that contains a dashboard_task.

Category: Other | Tags: BI

How it works

Refresh Databricks dashboard '<<DashboardId>>'

To use this activity within the API, use an ActivityCode of REFRESH-DATABRICKS-DASHBOARD.

Example JSON​

An example of what the Task Config would look like for a task using this activity. Some of these variables would be set at the group level to avoid duplication between tasks.

{
  "DashboardId": "01f14765d80f1b92bba3f7a07a9da03e",
  "WarehouseId": "0123456789abcdef"
}

Variable Reference​

The following variables are supported:

  • DashboardId (Required) - The Lakeview / AI-BI dashboard to refresh.

  • IsFederated (Optional) - Makes task available to other Insight Factories within this organisation.

  • Links (Optional)

  • MaximumNumberOfAttemptsAllowed (Optional) - The total number of times the running of this Task can be attempted.

  • MaximumRunTimeHours (Optional) - The maximum number of hours a task run is expected to take. If a run exceeds this duration it will be flagged as stuck.

  • MinutesToWaitBeforeNextAttempt (Optional) - If a Task run fails, the number of minutes to wait before re-attempting the Task.

  • WarehouseId (Optional) - Optional. SQL warehouse used to run the refresh. If omitted, the dashboard's default warehouse is used.