Skip to main content
PUT
Set a dashboard schedule
Minimum required API key scope: Read/Write

Use Cases

  • Keep a Dashboard Fresh: Refresh all the queries of a dashboard on a schedule, so viewers see recent data.
  • Change a Schedule: Change the frequency or performance tier. The response has created: false when it replaced a schedule.

Headers

X-Dune-Api-Key
string
required

API Key for the service

Path Parameters

dashboard_id
integer
required

Dashboard ID

Body

application/json

Schedule settings

cron_expression
string
required

CronExpression is a 5-part cron expression in UTC. Supported: every 15, 20 or 30 minutes ("*/15 * * * *"), hourly ("0 * * * *"), every 2, 3, 4, 6, 8 or 12 hours ("0 */6 * * *"), daily ("M H * * *") and weekly ("M H * * D"), where M is 0 or 30.

Example:

"0 6 * * *"

performance
enum<string>
required

Performance is the engine tier each run uses and must be available on your plan. Every run is charged credits at this tier.

Available options:
small,
medium,
large
Example:

"medium"

expires_at
string

ExpiresAt stops the schedule after this time. Omitted means no expiration; the free plan caps it at 3 months.

Response

OK

created
boolean

Created is true when the request created the schedule, false when it replaced one.

cron_expression
string

CronExpression is a 5-part cron expression in UTC.

Example:

"0 6 * * *"

dashboard_id
integer

DashboardID is set for dashboard schedules.

expires_at
string

ExpiresAt is absent when the schedule does not expire.

next_execution_time
string
performance
enum<string>

Performance is the engine tier each run uses.

Available options:
small,
medium,
large
Example:

"medium"

query_id
integer

QueryID is set for query and materialized view schedules.

Example:

1234567

type
enum<string>

Type is what the schedule runs. Materialized view refreshes are managed through the /v1/materialized-views endpoints.

Available options:
query,
dashboard,
materialized_view
Example:

"query"