Skip to main content

Schedule

View as Markdown

Schedule object​

A schedule periodically runs a dashboard on a cron cadence. Each run executes the dashboard's queries to refresh its cached data and sends a snapshot of the dashboard to the schedule's subscribers. See Manage scheduled dashboard updates and subscriptions for details.

schedule_idstringOutput only

UUID identifying the schedule.

Example: 01ef0cb45e2a1da4a61950e9b8789ce9

dashboard_idstringOutput only

UUID identifying the dashboard to which the schedule belongs.

Example: 04aab30f99ea444490c10c85852f216c

cron_scheduleobject

The cron expression and time zone that define when the schedule runs.

Show child attributesHide child attributes
quartz_cron_expressionstring

A cron expression in Quartz syntax that defines when the schedule runs. See the Quartz cron trigger tutorial for the syntax.

Example: 0 0 8 * * ?

timezone_idstring

A Java timezone id. The schedule will be resolved with respect to this timezone. See Java TimeZone for details.

Example: Europe/London

pause_statusstring

Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but the dashboard is not refreshed and no notifications are sent until the schedule is unpaused.

Default: UNPAUSED

Values:

  • UNPAUSED
  • PAUSED
display_namestring<= 255 characters

The name of the schedule, as shown in the dashboard's list of schedules.

Example: Monthly Traffic Report Snapshot

etagstring

The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete.

Example: 80611980

create_timestringOutput only

A timestamp indicating when the schedule was created.

update_timestringOutput only

A timestamp indicating when the schedule was last updated.

warehouse_idstring

The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If omitted, the warehouse of the published dashboard is used.

Example: 47bb1c472649e711

Get dashboard schedule GA​

GET /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}

Get dashboard schedule.

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 dashboard to which the schedule belongs.

Example: 04aab30f99ea444490c10c85852f216c

schedule_idstringRequiredpath

UUID identifying the schedule.

Example: 01ef0cb45e2a1da4a61950e9b8789ce9

Response​

Returns the Schedule object.

List dashboard schedules GA​

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

List dashboard schedules.

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 dashboard to which the schedules belong.

Example: 04aab30f99ea444490c10c85852f216c

page_sizeint32[ 1 .. 100 ]query

The number of schedules to return per page.

Default: 20

page_tokenstringquery

A page token, received from a previous ListSchedules call. Use this to retrieve the subsequent page.

Example: EAI=

Response​

Returns a list of Schedule objects.

Create dashboard schedule GA​

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

Creates a schedule for a dashboard. The dashboard must be published before a schedule can be created for it.

Requires the Databricks SQL access entitlement. Grant Databricks SQL access in addition to Workspace access.

API scopes: dashboards

Parameters​

dashboard_idstringRequiredpath

UUID identifying the dashboard to which the schedule belongs.

Example: 04aab30f99ea444490c10c85852f216c

Request body​

The schedule to create. A dashboard is limited to 10 schedules.

cron_scheduleobjectRequired

The cron expression and time zone that define when the schedule runs.

Show child attributesHide child attributes
quartz_cron_expressionstringRequired

A cron expression in Quartz syntax that defines when the schedule runs. See the Quartz cron trigger tutorial for the syntax.

Example: 0 0 8 * * ?

timezone_idstringRequired

A Java timezone id. The schedule will be resolved with respect to this timezone. See Java TimeZone for details.

Example: Europe/London

pause_statusstring

Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but the dashboard is not refreshed and no notifications are sent until the schedule is unpaused.

Default: UNPAUSED

Values:

  • UNPAUSED
  • PAUSED
display_namestring<= 255 characters

The name of the schedule, as shown in the dashboard's list of schedules.

Example: Monthly Traffic Report Snapshot

warehouse_idstring

The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If omitted, the warehouse of the published dashboard is used.

Example: 47bb1c472649e711

Response​

Returns the Schedule object.

Update dashboard schedule GA​

PUT /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}

Updates a schedule. The request body replaces the stored schedule, so fields omitted from the body are reset to their defaults.

Requires the Databricks SQL access entitlement. Grant Databricks SQL access in addition to Workspace access.

API scopes: dashboards

Parameters​

dashboard_idstringRequiredpath

UUID identifying the dashboard to which the schedule belongs.

Example: 04aab30f99ea444490c10c85852f216c

schedule_idstringRequiredpath

UUID identifying the schedule.

Example: 01ef0cb45e2a1da4a61950e9b8789ce9

Request body​

The schedule to update.

cron_scheduleobjectRequired

The cron expression and time zone that define when the schedule runs.

Show child attributesHide child attributes
quartz_cron_expressionstringRequired

A cron expression in Quartz syntax that defines when the schedule runs. See the Quartz cron trigger tutorial for the syntax.

Example: 0 0 8 * * ?

timezone_idstringRequired

A Java timezone id. The schedule will be resolved with respect to this timezone. See Java TimeZone for details.

Example: Europe/London

pause_statusstring

Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but the dashboard is not refreshed and no notifications are sent until the schedule is unpaused.

Default: UNPAUSED

Values:

  • UNPAUSED
  • PAUSED
display_namestring<= 255 characters

The name of the schedule, as shown in the dashboard's list of schedules.

Example: Monthly Traffic Report Snapshot

etagstring

The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete.

Example: 80611980

warehouse_idstring

The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If omitted, the warehouse of the published dashboard is used.

Example: 47bb1c472649e711

Response​

Returns the Schedule object.

Delete dashboard schedule GA​

DELETE /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}

Deletes a schedule together with all of its subscriptions.

Requires the Databricks SQL access entitlement. Grant Databricks SQL access in addition to Workspace access.

API scopes: dashboards

Parameters​

dashboard_idstringRequiredpath

UUID identifying the dashboard to which the schedule belongs.

Example: 04aab30f99ea444490c10c85852f216c

schedule_idstringRequiredpath

UUID identifying the schedule.

Example: 01ef0cb45e2a1da4a61950e9b8789ce9

etagstringquery

The etag for the schedule. Optionally, it can be provided to verify that the schedule has not been modified from its last retrieval.

Example: 80611980