Salesforce Reports and Dashboards REST API Developer Guide

Overview
Examples
Reports Examples
Dashboards Examples
Get List of Recently Used Dashboards
Get Dashboard Results
Filter Dashboard Results
Get Dashboard Status
Refresh a Dashboard
Save a Dashboard
Save a Dashboard with a Custom Lightning Web Component (Beta)
Set a Sticky Dashboard Filter
Return Details About Dashboard Components
Get Dashboard Metadata
Clone a Dashboard
Delete a Dashboard
Downloads Examples
Notifications Examples
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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.

Use a PUT request on the Dashboard Results resource to trigger a refresh of a dashboard. The refresh response returns the URL of the status resource after the refresh is triggered. If filter parameters are included in the PUT request, only the filtered data will be refreshed. For more information on filtering, see Filter Dashboard Results.

Example Usage

The following PUT request refreshes the dashboard with the ID of 01ZD00000007S89MAE.

1/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE

Example Request Body

None required.

Example Response Body

The response contains the status URL for the refreshed dashboard:

1{ 
2  "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status" 
3}