Return Details About Dashboard Components

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

Use a POST request on the Dashboard Results resource to get details about one or more dashboard components. Specify which dashboard components you want details about using componentIds in the request body. Available in API versions 36.0 and later.

Example Usage 

1/services/data/v36.0/analytics/dashboards/01ZR00000008h2EMAQ

Example Request Body 

1{
2 "componentIds": ["01aR00000005aT4IAI", "01aR00000005aT5IAI"]
3}

Example Response Body 

1{
2  "attributes" : {
3    "dashboardId" : "01ZR00000008h2EMAQ",
4    "dashboardName" : "Liz's Sales Manager Dashboard",
5    "describeUrl" : "/services/data/v37.0/analytics/dashboards/01ZR00000008h2EMAQ/describe",
6    "statusUrl" : "/services/data/v37.0/analytics/dashboards/01ZR00000008h2EMAQ/status",
7    "type" : "Dashboard"
8  },
9  "componentData" : [ {
10    "componentId" : "01aR00000005aT4IAI",
11    "reportResult" : {
12      "attributes" : null,
13      "allData" : true,
14      "factMap" : {
15        "0!T" : {
16          "aggregates" : [ {
17            "label" : "$10,000.00",
18            "value" : 10000
19          } ]
20        },
21        "1!T" : {
22          "aggregates" : [ {
23            "label" : "$110,000.00",
24            "value" : 110000
25          } ]
26        },
27        "0_0!T" : {
28          "aggregates" : [ {
29            "label" : "$10,000.00",
30            "value" : 10000
31          } ]
32        },
33        "2_2!T" : {
34          "aggregates" : [ {
35            "label" : "$143.00",
36            "value" : 143
37          } ]
38        },
39        "2!T" : {
40          "aggregates" : [ {
41            "label" : "$400,398.00",
42            "value" : 400398
43          } ]
44        },
45        "0_1!T" : {
46          "aggregates" : [ {
47            "label" : "$0.00",
48            "value" : 0
49          } ]
50        },
51        "2_3!T" : {
52          "aggregates" : [ {
53            "label" : "$100,017.00",
54            "value" : 100017
55          } ]
56        },
57        "T!T" : {
58          "aggregates" : [ {
59            "label" : "$520,398.00",
60            "value" : 520398
61          } ]
62        },
63        "2_0!T" : {
64          "aggregates" : [ {
65            "label" : "$138.00",
66            "value" : 138
67          } ]
68        },
69        "1_0!T" : {
70          "aggregates" : [ {
71            "label" : "$110,000.00",
72            "value" : 110000
73          } ]
74        },
75        "2_1!T" : {
76          "aggregates" : [ {
77            "label" : "$300,100.00",
78            "value" : 300100
79          } ]
80        }
81      },
82      "groupingsAcross" : null,
83      "groupingsDown" : {
84        "groupings" : [ {
85          "groupings" : [ {
86            "groupings" : [ ],
87            "key" : "0_0",
88            "label" : "-",
89            "value" : null
90          }, {
91            "groupings" : [ ],
92            "key" : "0_1",
93            "label" : "-",
94            "value" : null
95          } ],
96          "key" : "0",
97          "label" : "January 2016",
98          "value" : "January 2016"
99        }, {
100          "groupings" : [ {
101            "groupings" : [ ],
102            "key" : "1_0",
103            "label" : "-",
104            "value" : null
105          } ],
106          "key" : "1",
107          "label" : "February 2016",
108          "value" : "February 2016"
109        }, {
110          "groupings" : [ {
111            "groupings" : [ ],
112            "key" : "2_0",
113            "label" : "-",
114            "value" : null
115          }, {
116            "groupings" : [ ],
117            "key" : "2_1",
118            "label" : "-",
119            "value" : null
120          }, {
121            "groupings" : [ ],
122            "key" : "2_2",
123            "label" : "-",
124            "value" : null
125          }, {
126            "groupings" : [ ],
127            "key" : "2_3",
128            "label" : "-",
129            "value" : null
130          } ],
131          "key" : "2",
132          "label" : "March 2016",
133          "value" : "March 2016"
134        } ]
135      },
136      "hasDetailRows" : false,
137      "reportExtendedMetadata" : {
138        "aggregateColumnInfo" : {
139          "s!AMOUNT" : {
140            "dataType" : "currency",
141            "label" : "Sum of Amount"
142          }
143        },
144        "detailColumnInfo" : { },
145        "groupingColumnInfo" : {
146          "ACCOUNT_NAME" : {
147            "dataType" : "string",
148            "groupingLevel" : 0,
149            "label" : "Account Name"
150          },
151          "CLOSE_DATE" : {
152            "dataType" : "date",
153            "groupingLevel" : 0,
154            "label" : "Close Date"
155          }
156        }
157      },
158      "reportMetadata" : {
159        "aggregates" : [ "s!AMOUNT" ],
160        "buckets" : [ {
161          "bucketType" : "picklist",
162          "devloperName" : "BucketField_47575792",
163          "label" : "Industry",
164          "nullTreatedAsZero" : false,
165          "otherBucketLabel" : null,
166          "sourceColumnName" : "INDUSTRY",
167          "values" : [ {
168            "label" : "Technology",
169            "rangeUpperBound" : null,
170            "sourceDimensionValues" : [ "Agriculture", "Apparel", "Banking", "Biotechnology", "Chemicals", "Communications", "Construction", "Consulting", "Education", "Electronics" ]
171          }, {
172            "label" : "Energy",
173            "rangeUpperBound" : null,
174            "sourceDimensionValues" : [ "Energy", "Engineering", "Entertainment", "Environmental", "Finance", "Food & Beverage", "Government", "Healthcare", "Hospitality", "Insurance", "Machinery", "Manufacturing" ]
175          }, {
176            "label" : "Healthcare",
177            "rangeUpperBound" : null,
178            "sourceDimensionValues" : [ "Media", "Not For Profit", "Other", "Recreation", "Retail", "Shipping", "Technology", "Telecommunications", "Transportation", "Utilities" ]
179          } ]
180        }, {
181          "bucketType" : "picklist",
182          "devloperName" : "BucketField_36625466",
183          "label" : "Stage",
184          "nullTreatedAsZero" : false,
185          "otherBucketLabel" : null,
186          "sourceColumnName" : "STAGE_NAME",
187          "values" : [ {
188            "label" : "Early",
189            "rangeUpperBound" : null,
190            "sourceDimensionValues" : [ "Prospecting", "Qualification", "Needs Analysis" ]
191          }, {
192            "label" : "Late",
193            "rangeUpperBound" : null,
194            "sourceDimensionValues" : [ "Value Proposition", "Id. Decision Makers", "Perception Analysis", "Proposal/Price Quote", "Negotiation/Review" ]
195          }, {
196            "label" : "Won",
197            "rangeUpperBound" : null,
198            "sourceDimensionValues" : [ "Closed Won" ]
199          }, {
200            "label" : "Lost",
201            "rangeUpperBound" : null,
202            "sourceDimensionValues" : [ "Closed Lost" ]
203          } ]
204        } ],
205        "chart" : null,
206        "crossFilters" : [ ],
207        "currency" : null,
208        "description" : null,
209        "detailColumns" : [ ],
210        "developerName" : "Deals_Closing_This_Quarter",
211        "division" : null,
212        "folderId" : "00lR0000000M8IiIAK",
213        "groupingsAcross" : [ ],
214        "groupingsDown" : [ {
215          "dateGranularity" : "None",
216          "name" : "ACCOUNT_NAME",
217          "sortAggregate" : null,
218          "sortOrder" : "Asc"
219        }, {
220          "dateGranularity" : "Month",
221          "name" : "CLOSE_DATE",
222          "sortAggregate" : null,
223          "sortOrder" : "Asc"
224        } ],
225        "hasDetailRows" : false,
226        "hasRecordCount" : true,
227        "historicalSnapshotDates" : [ ],
228        "id" : "00OR0000000K2UeMAK",
229        "name" : "Deals Closing This Quarter",
230        "reportBooleanFilter" : null,
231        "reportFilters" : [ {
232          "column" : "BucketField_36625466",
233          "isRunPageEditable" : true,
234          "operator" : "equals",
235          "value" : "Early,Late"
236        }, {
237          "column" : "TYPE",
238          "isRunPageEditable" : true,
239          "operator" : "equals",
240          "value" : "Existing Business,New Business"
241        } ],
242        "reportFormat" : "SUMMARY",
243        "reportType" : {
244          "label" : "Opportunities",
245          "type" : "Opportunity"
246        },
247        "scope" : "organization",
248        "showGrandTotal" : true,
249        "showSubtotals" : true,
250        "sortBy" : [ ],
251        "standardDateFilter" : {
252          "column" : "CLOSE_DATE",
253          "durationValue" : "THIS_FISCAL_QUARTER",
254          "endDate" : "2016-06-30",
255          "startDate" : "2016-04-01"
256        },
257        "standardFilters" : [ {
258          "name" : "open",
259          "value" : "all"
260        }, {
261          "name" : "probability",
262          "value" : ">0"
263        } ]
264      }
265    },
266    "status" : {
267      "dataStatus" : "DATA",
268      "errorCode" : null,
269      "errorMessage" : null,
270      "errorSeverity" : null,
271      "refreshDate" : "2016-03-22T18:24:39.000+0000",
272      "refreshStatus" : "IDLE"
273    }
274  }, {
275    "componentId" : "01aR00000005aT5IAI",
276    "reportResult" : {
277      "attributes" : null,
278      "allData" : true,
279      "factMap" : {
280        "0!T" : {
281          "aggregates" : [ {
282            "label" : "$634,493.00",
283            "value" : 634493
284          } ]
285        },
286        "1!T" : {
287          "aggregates" : [ {
288            "label" : "$590,036.00",
289            "value" : 590036
290          } ]
291        },
292        "0_0!T" : {
293          "aggregates" : [ {
294            "label" : "$14.00",
295            "value" : 14
296          } ]
297        },
298        "2!T" : {
299          "aggregates" : [ {
300            "label" : "$1,330,035.00",
301            "value" : 1330035
302          } ]
303        },
304        "0_1!T" : {
305          "aggregates" : [ {
306            "label" : "$36,021.00",
307            "value" : 36021
308          } ]
309        },
310        "0_2!T" : {
311          "aggregates" : [ {
312            "label" : "$5,000.00",
313            "value" : 5000
314          } ]
315        },
316        "1_3!T" : {
317          "aggregates" : [ {
318            "label" : "$500,000.00",
319            "value" : 500000
320          } ]
321        },
322        "T!T" : {
323          "aggregates" : [ {
324            "label" : "$2,554,564.00",
325            "value" : 2554564
326          } ]
327        },
328        "0_3!T" : {
329          "aggregates" : [ {
330            "label" : "$440,000.00",
331            "value" : 440000
332          } ]
333        },
334        "1_4!T" : {
335          "aggregates" : [ {
336            "label" : "$13.00",
337            "value" : 13
338          } ]
339        },
340        "0_4!T" : {
341          "aggregates" : [ {
342            "label" : "$20,000.00",
343            "value" : 20000
344          } ]
345        },
346        "1_1!T" : {
347          "aggregates" : [ {
348            "label" : "$11.00",
349            "value" : 11
350          } ]
351        },
352        "0_5!T" : {
353          "aggregates" : [ {
354            "label" : "$90,000.00",
355            "value" : 90000
356          } ]
357        },
358        "1_2!T" : {
359          "aggregates" : [ {
360            "label" : "$40,000.00",
361            "value" : 40000
362          } ]
363        },
364        "0_6!T" : {
365          "aggregates" : [ {
366            "label" : "$43,320.00",
367            "value" : 43320
368          } ]
369        },
370        "0_7!T" : {
371          "aggregates" : [ {
372            "label" : "$138.00",
373            "value" : 138
374          } ]
375        },
376        "1_0!T" : {
377          "aggregates" : [ {
378            "label" : "$50,012.00",
379            "value" : 50012
380          } ]
381        },
382        "2_2!T" : {
383          "aggregates" : [ {
384            "label" : "$100,017.00",
385            "value" : 100017
386          } ]
387        },
388        "2_3!T" : {
389          "aggregates" : [ {
390            "label" : "$20,018.00",
391            "value" : 20018
392          } ]
393        },
394        "2_4!T" : {
395          "aggregates" : [ {
396            "label" : "$0.00",
397            "value" : 0
398          } ]
399        },
400        "2_0!T" : {
401          "aggregates" : [ {
402            "label" : "$100,000.00",
403            "value" : 100000
404          } ]
405        },
406        "2_1!T" : {
407          "aggregates" : [ {
408            "label" : "$1,110,000.00",
409            "value" : 1110000
410          } ]
411        }
412      },
413      "groupingsAcross" : null,
414      "groupingsDown" : {
415        "groupings" : [ {
416          "groupings" : [ {
417            "groupings" : [ ],
418            "key" : "0_0",
419            "label" : "March 2013",
420            "value" : "2013-03-01"
421          }, {
422            "groupings" : [ ],
423            "key" : "0_1",
424            "label" : "July 2015",
425            "value" : "2015-07-01"
426          }, {
427            "groupings" : [ ],
428            "key" : "0_2",
429            "label" : "August 2015",
430            "value" : "2015-08-01"
431          }, {
432            "groupings" : [ ],
433            "key" : "0_3",
434            "label" : "September 2015",
435            "value" : "2015-09-01"
436          }, {
437            "groupings" : [ ],
438            "key" : "0_4",
439            "label" : "October 2015",
440            "value" : "2015-10-01"
441          }, {
442            "groupings" : [ ],
443            "key" : "0_5",
444            "label" : "November 2015",
445            "value" : "2015-11-01"
446          }, {
447            "groupings" : [ ],
448            "key" : "0_6",
449            "label" : "December 2015",
450            "value" : "2015-12-01"
451          }, {
452            "groupings" : [ ],
453            "key" : "0_7",
454            "label" : "March 2016",
455            "value" : "2016-03-01"
456          } ],
457          "key" : "0",
458          "label" : "Manufacturing",
459          "value" : "Manufacturing"
460        }, {
461          "groupings" : [ {
462            "groupings" : [ ],
463            "key" : "1_0",
464            "label" : "February 2013",
465            "value" : "2013-02-01"
466          }, {
467            "groupings" : [ ],
468            "key" : "1_1",
469            "label" : "February 2015",
470            "value" : "2015-02-01"
471          }, {
472            "groupings" : [ ],
473            "key" : "1_2",
474            "label" : "September 2015",
475            "value" : "2015-09-01"
476          }, {
477            "groupings" : [ ],
478            "key" : "1_3",
479            "label" : "February 2016",
480            "value" : "2016-02-01"
481          }, {
482            "groupings" : [ ],
483            "key" : "1_4",
484            "label" : "April 2016",
485            "value" : "2016-04-01"
486          } ],
487          "key" : "1",
488          "label" : "Media",
489          "value" : "Media"
490        }, {
491          "groupings" : [ {
492            "groupings" : [ ],
493            "key" : "2_0",
494            "label" : "November 2015",
495            "value" : "2015-11-01"
496          }, {
497            "groupings" : [ ],
498            "key" : "2_1",
499            "label" : "December 2015",
500            "value" : "2015-12-01"
501          }, {
502            "groupings" : [ ],
503            "key" : "2_2",
504            "label" : "March 2016",
505            "value" : "2016-03-01"
506          }, {
507            "groupings" : [ ],
508            "key" : "2_3",
509            "label" : "May 2016",
510            "value" : "2016-05-01"
511          }, {
512            "groupings" : [ ],
513            "key" : "2_4",
514            "label" : "June 2016",
515            "value" : "2016-06-01"
516          } ],
517          "key" : "2",
518          "label" : "Technology",
519          "value" : "Technology"
520        } ]
521      },
522      "hasDetailRows" : false,
523      "reportExtendedMetadata" : {
524        "aggregateColumnInfo" : {
525          "s!AMOUNT" : {
526            "dataType" : "currency",
527            "label" : "Sum of Amount"
528          }
529        },
530        "detailColumnInfo" : { },
531        "groupingColumnInfo" : {
532          "INDUSTRY" : {
533            "dataType" : "picklist",
534            "groupingLevel" : 0,
535            "label" : "Industry"
536          },
537          "CLOSE_DATE" : {
538            "dataType" : "date",
539            "groupingLevel" : 0,
540            "label" : "Close Date"
541          }
542        }
543      },
544      "reportMetadata" : {
545        "aggregates" : [ "s!AMOUNT" ],
546        "buckets" : [ {
547          "bucketType" : "picklist",
548          "devloperName" : "BucketField_47575792",
549          "label" : "Industry",
550          "nullTreatedAsZero" : false,
551          "otherBucketLabel" : null,
552          "sourceColumnName" : "INDUSTRY",
553          "values" : [ {
554            "label" : "Technology",
555            "rangeUpperBound" : null,
556            "sourceDimensionValues" : [ "Agriculture", "Apparel", "Banking", "Biotechnology", "Chemicals", "Communications", "Construction", "Consulting", "Education", "Electronics" ]
557          }, {
558            "label" : "Energy",
559            "rangeUpperBound" : null,
560            "sourceDimensionValues" : [ "Energy", "Engineering", "Entertainment", "Environmental", "Finance", "Food & Beverage", "Government", "Healthcare", "Hospitality", "Insurance", "Machinery", "Manufacturing" ]
561          }, {
562            "label" : "Healthcare",
563            "rangeUpperBound" : null,
564            "sourceDimensionValues" : [ "Media", "Not For Profit", "Other", "Recreation", "Retail", "Shipping", "Technology", "Telecommunications", "Transportation", "Utilities" ]
565          } ]
566        }, {
567          "bucketType" : "picklist",
568          "devloperName" : "BucketField_36625466",
569          "label" : "Stage",
570          "nullTreatedAsZero" : false,
571          "otherBucketLabel" : null,
572          "sourceColumnName" : "STAGE_NAME",
573          "values" : [ {
574            "label" : "Early",
575            "rangeUpperBound" : null,
576            "sourceDimensionValues" : [ "Prospecting", "Qualification", "Needs Analysis" ]
577          }, {
578            "label" : "Late",
579            "rangeUpperBound" : null,
580            "sourceDimensionValues" : [ "Value Proposition", "Id. Decision Makers", "Perception Analysis", "Proposal/Price Quote", "Negotiation/Review" ]
581          }, {
582            "label" : "Won",
583            "rangeUpperBound" : null,
584            "sourceDimensionValues" : [ "Closed Won" ]
585          }, {
586            "label" : "Lost",
587            "rangeUpperBound" : null,
588            "sourceDimensionValues" : [ "Closed Lost" ]
589          } ]
590        } ],
591        "chart" : null,
592        "crossFilters" : [ ],
593        "currency" : null,
594        "description" : null,
595        "detailColumns" : [ ],
596        "developerName" : "Pipeline_By_Industry1",
597        "division" : null,
598        "folderId" : "005R0000000Hv5rIAC",
599        "groupingsAcross" : [ ],
600        "groupingsDown" : [ {
601          "dateGranularity" : "None",
602          "name" : "INDUSTRY",
603          "sortAggregate" : null,
604          "sortOrder" : "Asc"
605        }, {
606          "dateGranularity" : "Month",
607          "name" : "CLOSE_DATE",
608          "sortAggregate" : null,
609          "sortOrder" : "Asc"
610        } ],
611        "hasDetailRows" : true,
612        "hasRecordCount" : false,
613        "historicalSnapshotDates" : [ ],
614        "id" : "00OR0000000OgsOMAS",
615        "name" : "Copy of Pipeline By Industry",
616        "reportBooleanFilter" : null,
617        "reportFilters" : [ {
618          "column" : "ACCOUNT_TYPE",
619          "isRunPageEditable" : false,
620          "operator" : "lessOrEqual",
621          "value" : "Integrator,Partner,Prospect"
622        }, {
623          "column" : "INDUSTRY",
624          "isRunPageEditable" : true,
625          "operator" : "notEqual",
626          "value" : ""
627        } ],
628        "reportFormat" : "SUMMARY",
629        "reportType" : {
630          "label" : "Opportunities",
631          "type" : "Opportunity"
632        },
633        "scope" : "organization",
634        "showGrandTotal" : true,
635        "showSubtotals" : true,
636        "sortBy" : [ ],
637        "standardDateFilter" : {
638          "column" : "CLOSE_DATE",
639          "durationValue" : "CUSTOM",
640          "endDate" : null,
641          "startDate" : null
642        },
643        "standardFilters" : [ {
644          "name" : "open",
645          "value" : "all"
646        }, {
647          "name" : "probability",
648          "value" : ">0"
649        } ]
650      }
651    },
652    "status" : {
653      "dataStatus" : "DATA",
654      "errorCode" : null,
655      "errorMessage" : null,
656      "errorSeverity" : null,
657      "refreshDate" : "2016-03-22T18:24:39.000+0000",
658      "refreshStatus" : "IDLE"
659    }
660  } ],
661  "dashboardMetadata" : {
662    "canChangeRunningUser" : false,
663    "components" : [ {
664      "componentData" : 0,
665      "footer" : null,
666      "header" : "Pipeline This Quarter",
667      "id" : "01aR00000005aT4IAI",
668      "properties" : {
669        "aggregates" : [ {
670          "name" : "s!AMOUNT"
671        } ],
672        "autoSelectColumns" : false,
673        "filterColumns" : [ ],
674        "groupings" : null,
675        "maxRows" : null,
676        "sort" : null,
677        "useReportChart" : false,
678        "visualizationProperties" : {
679          "breakPoints" : [ {
680            "aggregateName" : "s!AMOUNT",
681            "breaks" : [ {
682              "color" : "c23934",
683              "lowerBound" : 0,
684              "upperBound" : 200000
685            }, {
686              "color" : "ffb75d",
687              "lowerBound" : 200000,
688              "upperBound" : 400000
689            }, {
690              "color" : "00716b",
691              "lowerBound" : 400000,
692              "upperBound" : 600000
693            } ]
694          } ],
695          "showPercentages" : true,
696          "showTotal" : true
697        },
698        "visualizationType" : "Gauge"
699      },
700      "reportId" : "00OR0000000K2UeMAK",
701      "title" : null,
702      "type" : "Report"
703    }, {
704      "componentData" : 1,
705      "footer" : null,
706      "header" : "Pipeline by Industry",
707      "id" : "01aR00000005aT5IAI",
708      "properties" : {
709        "aggregates" : [ {
710          "name" : "s!AMOUNT"
711        } ],
712        "autoSelectColumns" : false,
713        "filterColumns" : [ ],
714        "groupings" : [ {
715          "name" : "INDUSTRY"
716        } ],
717        "maxRows" : null,
718        "sort" : {
719          "column" : "INDUSTRY",
720          "sortOrder" : "asc"
721        },
722        "useReportChart" : false,
723        "visualizationProperties" : {
724          "combineSmallGroups" : false,
725          "legendPosition" : "Bottom",
726          "showPercentages" : false,
727          "showTotal" : false,
728          "showValues" : false
729        },
730        "visualizationType" : "Donut"
731      },
732      "reportId" : "00OR0000000OgsOMAS",
733      "title" : null,
734      "type" : "Report"
735    } ],
736    "description" : null,
737    "developerName" : "yTtOilrkFGewFKpFUOscDuukUApfxH",
738    "filters" : [ ],
739    "folderId" : "00lR0000000DnRZIA0",
740    "id" : "01ZR00000008h2EMAQ",
741    "layout" : {
742      "components" : [ {
743        "colspan" : 3,
744        "column" : 0,
745        "row" : 0,
746        "rowspan" : 4
747      }, {
748        "colspan" : 3,
749        "column" : 0,
750        "row" : 4,
751        "rowspan" : 4
752      } ],
753      "gridLayout" : true,
754      "numColumns" : 9,
755      "rowHeight" : 80
756    },
757    "name" : "Liz's Sales Manager Dashboard",
758    "runningUser" : {
759      "displayName" : "Vandelay Art",
760      "id" : "005R0000000Hv5rIAC"
761    }
762  }
763}