Dashboards Examples

Learn how to refresh, create, edit, copy, and delete dashboards.

• Get List of Recently Used Dashboards

  You can get a list of recently used dashboards by using the Dashboard resource.

• Get Dashboard Results

  You can get dashboard metadata, data, and status by sending a GET request to the Dashboard Results resource.

• Filter Dashboard Results

  You can filter dashboard results, status, or refresh requests, by using filter parameters.

• Get Dashboard Status

  You can get the dashboard status by sending a GET request to the Dashboard Status resource.

• Refresh a Dashboard

  You can refresh a dashboard by using a PUT Dashboard Results request. Dynamic dashboards can also be refreshed via the REST API.

• Save a Dashboard

  You can save changes to a dashboard by sending a PATCH request to the Dashboard Results resource.

• Save a Dashboard with a Custom Lightning Web Component (Beta)

  You can save a dashboard with a custom Lightning web component by sending a PATCH request to the Dashboard Results resource.

• Set a Sticky Dashboard Filter

  Set a default filter value which gets applied to a dashboard when you open it. The default filter value you specify only applies to you (other people won’t see it when they open the dashboard). If you change the filter value while viewing the dashboard, then the filter value you set in the user interface overwrites the value you set via the API. To set sticky filters for a dashboard, canUseStickyFilter must equal true.

• Return Details About Dashboard Components

  Get details about one or more dashboard components using a POST request.

• Get Dashboard Metadata

  Get details about dashboard metadata using a GET request.

• Clone a Dashboard

  Creates a copy of a dashboard by sending a POST request to the Dashboard List resource.

• Delete a Dashboard