Salesforce Reports and Dashboards REST API Developer Guide
jNote: 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.
Get Dashboard Status
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:
1/services/data/v31.0/analytics/dashboards/01ZD00000007QevMAE/statusExample Response Body
The response contains the status for each component, along with the refresh date and time:
1{
2 "componentStatus" : [ {
3 "componentId" : "01aD0000000J7M7",
4 "refreshDate" : "2014-03-10T17:26:07.000+0000",
5 "refreshStatus" : "IDLE"
6 }, {
7 "componentId" : "01aD0000000J7M9",
8 "refreshDate" : "2014-03-10T17:26:08.000+0000",
9 "refreshStatus" : "IDLE"
10 }, {
11 "componentId" : "01aD0000000J7MB",
12 "refreshDate" : "2014-03-10T17:26:09.000+0000",
13 "refreshStatus" : "IDLE"
14 } ]
15}