Refresh Dashboard Charts

Refresh all Charts in a Dashboard

Description

This job triggers all charts in a dashboard to refresh using a combination of endpoints including the charts-and-results endpoint.

Use Cases

We recommend creating a Refresh Dashboard Charts task for every 'Dashboard' in Lightdash.

This way, you can use Orchestra to trigger your refreshes on a cron or event based schedule. This has a number of advantages vs. manually triggering refreshes:

• You can co-ordinate tasks outside of Lightdash - these would typically be specific dbt job runs or operations that you know need to succeed before building your dashboards.

  • A common use-case is to have a dbt run job that transform the data so it is ready for Lightdash to use. This way, you can ensure data pushed to Lightdash adheres to data quality constraints.

• You can use Orchestra to trigger jobs across Lightdash accounts

• When Lightdash jobs run, cost is incurred. Running these operations on a schedule you set explicitly ensures these costs do not go out of hand

Parameters

These parameters are required to run the Dataset materialisation task

Name	Data type	Restrictions	Example
Dashboard ID	string	N.A.	e2d0cbff-121a-45f4-********************

The dashboard ID should be in the URL. It is of the format <LIGHTDASH_HOST>/projects/<PROJECT_ID>/dashboards/<DASHBOARD_ID>. Copy the value and store here in 'Dashboard ID'

Error handling

API Requests

If we receive the following error codes from Lightdash, we'll raise an error and the task will move to a failed state.

Code	Description	Handling
401	Unauthorised	We will raise an error and parse the raw error message from the Sigma response as the Orchestra message
404	Not Found	We will raise an error with the HTTP Reason as the Orchestra message
500	Invalid UUID	If you enter an invalid UUID as dashboard ID we receive a 500. Orchestra parses this error for you to help debug the issue
Other error code		We will raise an error with the HTTP Reason as the Orchestra message