How do I edit a dashboard's tiles via the API?

Knowledge Drop

Last tested: Oct 1, 2019

In the update_dashboard call in the 3.0 API, dashboard_elements array is read-only and cannot be altered, so this call can only be used to edit simple properties of the dashboard, such as the title. However, as of Looker 5.14, there are calls you can make in API 3.1 to edit a dashboard's tiles. Here are the steps you can take:

  1. Use the dashboard_dashboard_elements call to get the query information for all of the dashboard elements.
  2. Edit the parameters in the query body for each tile you want to edit.
  3. Use the create_query call to get a new query id from the edited query information for each tile.
  4. Use the update_dashboard_element call on each tile to change it over to the new query id.

Besides editing tiles, you can also add and delete tiles via these new endpoints, as well as adjust other dashboard features such as layout and filters.

This content is subject to limited support.                

Version history
Last update:
‎06-14-2021 06:18 PM
Updated by: