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 Metadata
Get details about dashboard metadata using a GET request.
Use a GET request on the Dashboard Describe resource to get metadata for the specified dashboard, including dashboard components, filters, layout, and the running user.
Example Usage
1/services/data/v37.0/analytics/dashboards/01ZR00000004SknMAE/describeExample Response Body
1{
2 "canChangeRunningUser" : true,
3 "components" : [ {
4 "componentData" : 0,
5 "footer" : null,
6 "header" : null,
7 "id" : "01aR00000005kCmIAI",
8 "properties" : {
9 "aggregates" : [ {
10 "name" : "s!AMOUNT"
11 } ],
12 "autoSelectColumns" : true,
13 "filterColumns" : [ {
14 "label" : "Closed",
15 "name" : "CLOSED"
16 }, {
17 "label" : "Account Type",
18 "name" : "ACCOUNT_TYPE"
19 }, {
20 "label" : "Annual Revenue",
21 "name" : "SALES"
22 } ],
23 "groupings" : [ {
24 "name" : "STAGE_NAME"
25 } ],
26 "maxRows" : null,
27 "sort" : {
28 "column" : "STAGE_NAME",
29 "sortOrder" : "asc"
30 },
31 "useReportChart" : false,
32 "visualizationProperties" : {
33 "axisRange" : {
34 "max" : null,
35 "min" : null,
36 "rangeType" : "auto"
37 },
38 "groupByType" : "cumulative",
39 "legendPosition" : "Bottom",
40 "showValues" : false
41 },
42 "visualizationType" : "Line"
43 },
44 "reportId" : "00OR0000000JizXMAS",
45 "title" : null,
46 "type" : "Report"
47 }, {
48 "componentData" : 1,
49 "footer" : null,
50 "header" : null,
51 "id" : "01aR00000005awVIAQ",
52 "properties" : {
53 "aggregates" : [ {
54 "name" : "s!AMOUNT"
55 } ],
56 "autoSelectColumns" : true,
57 "filterColumns" : [ {
58 "label" : "Closed",
59 "name" : "CLOSED"
60 }, {
61 "label" : "Account Type",
62 "name" : "ACCOUNT_TYPE"
63 }, {
64 "label" : "Annual Revenue",
65 "name" : "SALES"
66 } ],
67 "groupings" : [ {
68 "name" : "STAGE_NAME"
69 } ],
70 "maxRows" : null,
71 "sort" : {
72 "column" : "STAGE_NAME",
73 "sortOrder" : "asc"
74 },
75 "useReportChart" : false,
76 "visualizationProperties" : {
77 "combineSmallGroups" : true,
78 "legendPosition" : "Bottom",
79 "showPercentages" : false,
80 "showValues" : true
81 },
82 "visualizationType" : "Funnel"
83 },
84 "reportId" : "00OR0000000OFXeMAO",
85 "title" : null,
86 "type" : "Report"
87 }, {
88 "componentData" : 2,
89 "footer" : null,
90 "header" : null,
91 "id" : "01aR00000005awTIAQ",
92 "properties" : {
93 "aggregates" : [ {
94 "name" : "s!AMOUNT"
95 } ],
96 "autoSelectColumns" : true,
97 "filterColumns" : [ {
98 "label" : "Closed",
99 "name" : "CLOSED"
100 }, {
101 "label" : "Account Type",
102 "name" : "ACCOUNT_TYPE"
103 }, {
104 "label" : "Annual Revenue",
105 "name" : "SALES"
106 } ],
107 "groupings" : null,
108 "maxRows" : null,
109 "sort" : null,
110 "useReportChart" : false,
111 "visualizationProperties" : {
112 "breakPoints" : [ {
113 "aggregateName" : "s!AMOUNT",
114 "breaks" : [ {
115 "color" : "c25454",
116 "lowerBound" : 100000,
117 "upperBound" : 300000
118 }, {
119 "color" : "c2c254",
120 "lowerBound" : 300000,
121 "upperBound" : 800000
122 }, {
123 "color" : "54c254",
124 "lowerBound" : 800000,
125 "upperBound" : 1000000
126 } ]
127 } ],
128 "showPercentages" : false,
129 "showTotal" : false
130 },
131 "visualizationType" : "Gauge"
132 },
133 "reportId" : "00OR0000000JizXMAS",
134 "title" : null,
135 "type" : "Report"
136 }, {
137 "componentData" : 3,
138 "footer" : null,
139 "header" : null,
140 "id" : "01aR00000005kCnIAI",
141 "properties" : {
142 "aggregates" : [ {
143 "name" : "s!AMOUNT"
144 }, {
145 "name" : "a!AMOUNT"
146 } ],
147 "autoSelectColumns" : false,
148 "filterColumns" : [ {
149 "label" : "Closed",
150 "name" : "CLOSED"
151 }, {
152 "label" : "Account Type",
153 "name" : "ACCOUNT_TYPE"
154 }, {
155 "label" : "Annual Revenue",
156 "name" : "SALES"
157 } ],
158 "groupings" : [ {
159 "name" : "STAGE_NAME"
160 }, {
161 "name" : "TYPE"
162 } ],
163 "maxRows" : null,
164 "sort" : {
165 "column" : "STAGE_NAME",
166 "sortOrder" : "asc"
167 },
168 "useReportChart" : false,
169 "visualizationProperties" : {
170 "axisRange" : {
171 "max" : null,
172 "min" : null,
173 "rangeType" : "auto"
174 },
175 "groupByType" : "grouped",
176 "legendPosition" : "Bottom"
177 },
178 "visualizationType" : "Scatter"
179 },
180 "reportId" : "00OR0000000JizXMAS",
181 "title" : null,
182 "type" : "Report"
183 }, {
184 "componentData" : 4,
185 "footer" : null,
186 "header" : "My Table",
187 "id" : "01aR00000005awUIAQ",
188 "properties" : {
189 "aggregates" : [ {
190 "name" : "s!AMOUNT"
191 } ],
192 "autoSelectColumns" : false,
193 "filterColumns" : [ {
194 "label" : "Closed",
195 "name" : "CLOSED"
196 }, {
197 "label" : "Account Type",
198 "name" : "ACCOUNT_TYPE"
199 }, {
200 "label" : "Annual Revenue",
201 "name" : "SALES"
202 } ],
203 "groupings" : [ {
204 "name" : "INDUSTRY"
205 }, {
206 "name" : "CLOSE_DATE"
207 } ],
208 "maxRows" : null,
209 "sort" : {
210 "column" : "INDUSTRY",
211 "sortOrder" : "asc"
212 },
213 "useReportChart" : false,
214 "visualizationProperties" : {
215 "breakPoints" : [ {
216 "aggregateName" : "s!AMOUNT",
217 "breaks" : [ {
218 "color" : "c25454",
219 "lowerBound" : null,
220 "upperBound" : null
221 }, {
222 "color" : "c2c254",
223 "lowerBound" : null,
224 "upperBound" : null
225 }, {
226 "color" : "54c254",
227 "lowerBound" : null,
228 "upperBound" : null
229 } ]
230 } ],
231 "tableColumns" : [ {
232 "column" : "INDUSTRY",
233 "isPercent" : false,
234 "scale" : null,
235 "showTotal" : false,
236 "type" : "grouping"
237 }, {
238 "column" : "CLOSE_DATE",
239 "isPercent" : false,
240 "scale" : null,
241 "showTotal" : false,
242 "type" : "grouping"
243 }, {
244 "column" : "s!AMOUNT",
245 "isPercent" : false,
246 "scale" : null,
247 "showTotal" : true,
248 "type" : "aggregate"
249 } ]
250 },
251 "visualizationType" : "Table"
252 },
253 "reportId" : "00OR0000000OgsOMAS",
254 "title" : "My Table",
255 "type" : "Report"
256 }, {
257 "componentData" : 5,
258 "footer" : null,
259 "header" : null,
260 "id" : "01aR00000005kCoIAI",
261 "properties" : {
262 "aggregates" : [ {
263 "name" : "s!AMOUNT"
264 } ],
265 "autoSelectColumns" : false,
266 "filterColumns" : [ {
267 "label" : "Closed",
268 "name" : "CLOSED"
269 }, {
270 "label" : "Account Type",
271 "name" : "ACCOUNT_TYPE"
272 }, {
273 "label" : "Annual Revenue",
274 "name" : "SALES"
275 } ],
276 "groupings" : [ {
277 "name" : "STAGE_NAME"
278 }, {
279 "name" : "TYPE"
280 } ],
281 "maxRows" : null,
282 "sort" : {
283 "column" : "STAGE_NAME",
284 "sortOrder" : "asc"
285 },
286 "useReportChart" : false,
287 "visualizationProperties" : {
288 "aggregateVisualizationInfos" : [ {
289 "axis" : "Y2",
290 "visualizationType" : "Column"
291 } ],
292 "axisRange" : {
293 "max" : null,
294 "min" : null,
295 "rangeType" : "auto"
296 },
297 "groupByType" : "grouped",
298 "legendPosition" : "Bottom",
299 "showValues" : false
300 },
301 "visualizationType" : "Column"
302 },
303 "reportId" : "00OR0000000JizXMAS",
304 "title" : null,
305 "type" : "Report"
306 }, {
307 "componentData" : 6,
308 "footer" : null,
309 "header" : null,
310 "id" : "01aR00000005kCpIAI",
311 "properties" : {
312 "aggregates" : [ {
313 "name" : "s!AMOUNT"
314 }, {
315 "name" : "a!AMOUNT"
316 } ],
317 "autoSelectColumns" : false,
318 "filterColumns" : [ {
319 "label" : "Closed",
320 "name" : "CLOSED"
321 }, {
322 "label" : "Account Type",
323 "name" : "ACCOUNT_TYPE"
324 }, {
325 "label" : "Annual Revenue",
326 "name" : "SALES"
327 } ],
328 "groupings" : [ {
329 "name" : "STAGE_NAME"
330 } ],
331 "maxRows" : null,
332 "sort" : {
333 "column" : "STAGE_NAME",
334 "sortOrder" : "asc"
335 },
336 "useReportChart" : false,
337 "visualizationProperties" : {
338 "axisRange" : {
339 "max" : null,
340 "min" : null,
341 "rangeType" : "auto"
342 },
343 "groupByType" : "none",
344 "legendPosition" : "Bottom",
345 "showValues" : false
346 },
347 "visualizationType" : "Bar"
348 },
349 "reportId" : "00OR0000000JizXMAS",
350 "title" : null,
351 "type" : "Report"
352 } ],
353 "description" : null,
354 "developerName" : "Filtered_Dashboard",
355 "filters" : [ {
356 "errorMessage" : null,
357 "id" : "0IBR00000004CElOAM",
358 "name" : "Closed",
359 "options" : [ {
360 "alias" : "Open",
361 "endValue" : null,
362 "id" : "0ICR00000004CG4OAM",
363 "operation" : "equals",
364 "startValue" : null,
365 "value" : "True"
366 }, {
367 "alias" : "Closed",
368 "endValue" : null,
369 "id" : "0ICR00000004CG5OAM",
370 "operation" : "equals",
371 "startValue" : null,
372 "value" : "False"
373 } ],
374 "selectedOption" : null
375 }, {
376 "errorMessage" : null,
377 "id" : "0IBR00000004CEmOAM",
378 "name" : "Account Type",
379 "options" : [ {
380 "alias" : null,
381 "endValue" : null,
382 "id" : "0ICR00000004CG6OAM",
383 "operation" : "equals",
384 "startValue" : null,
385 "value" : "Analyst"
386 }, {
387 "alias" : null,
388 "endValue" : null,
389 "id" : "0ICR00000004CG7OAM",
390 "operation" : "equals",
391 "startValue" : null,
392 "value" : "Competitor"
393 }, {
394 "alias" : null,
395 "endValue" : null,
396 "id" : "0ICR00000004CG8OAM",
397 "operation" : "equals",
398 "startValue" : null,
399 "value" : "Press,Prospect,Reseller"
400 }, {
401 "alias" : null,
402 "endValue" : null,
403 "id" : "0ICR00000004CG9OAM",
404 "operation" : "notEqual",
405 "startValue" : null,
406 "value" : "Other"
407 }, {
408 "alias" : "Outsiders",
409 "endValue" : null,
410 "id" : "0ICR00000004CGAOA2",
411 "operation" : "lessOrEqual",
412 "startValue" : null,
413 "value" : "Integrator,Partner,Prospect"
414 } ],
415 "selectedOption" : null
416 }, {
417 "errorMessage" : null,
418 "id" : "0IBR0000000007cOAA",
419 "name" : "Annual Revenue",
420 "options" : [ {
421 "alias" : null,
422 "endValue" : null,
423 "id" : "0ICR000000000A5OAI",
424 "operation" : "lessThan",
425 "startValue" : null,
426 "value" : "\"400,000\""
427 } ],
428 "selectedOption" : null
429 } ],
430 "folderId" : "00lR0000000DnRZIA0",
431 "id" : "01ZR00000004SknMAE",
432 "layout" : {
433 "columns" : [ {
434 "components" : [ 0, 1, 2 ]
435 }, {
436 "components" : [ 3, 4 ]
437 }, {
438 "components" : [ 5, 6 ]
439 } ],
440 "gridLayout" : false
441 },
442 "name" : "Filtered Dashboard",
443 "runningUser" : {
444 "displayName" : "Vandelay Art",
445 "id" : "005R0000000Hv5rIAC"
446 }
447}