Salesforce Reports and Dashboards REST API Developer Guide

Introducing the Salesforce Reports and Dashboards REST API
Understanding Reports REST API Resources
Understanding Dashboards REST API Resources
Get List of Recently Used Dashboards
Get Dashboard Results
Filter Dashboard Results
Get Dashboard Status
Refresh a Dashboard
Save a Dashboard
Clone a Dashboard
Delete a Dashboard
Reports API Resource Reference
Dashboards API Resource Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Get Dashboard Status

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

Use the Dashboard Status resource to retrieve a status for each component of the dashboard. The components are listed in the order in which they were refreshed. The request returns IDLE if a component is not currently being refreshed, and RUNNING if a component is currently being refreshed.

Example Usage

To retrieve the status for a dashboard with an ID of 01ZD00000007QevMAE, you could make the following request:

Example Response Body

The response contains the status for each component, along with the refresh date and time: