Salesforce Reports and Dashboards REST API Developer Guide
jNewer Version Available
Get Report Data without Saving Changes to or Creating a Report
Run a report without creating a report or changing an existing one by making a POST
request to the query resource. Get report data without
filling up your org with unnecessary reports.
Example
Get report data using the query
resource.
1/services/data/v37.0/analytics/reports/queryInclude report criteria as reportMetadata in the POST request body. This POST request gets data about Opportunities:
1{
2"reportMetadata" : {
3 "aggregates" : [ "RowCount" ],
4 "chart" : null,
5 "crossFilters" : [ ],
6 "currency" : null,
7 "description" : null,
8 "detailColumns" : [ "OPPORTUNITY_NAME", "TYPE", "LEAD_SOURCE", "AMOUNT", "CLOSE_DATE", "NEXT_STEP", "STAGE_NAME", "PROBABILITY", "FISCAL_QUARTER", "AGE", "CREATED_DATE", "FULL_NAME", "ROLLUP_DESCRIPTION", "ACCOUNT_NAME" ],
9 "developerName" : "OpportunityReport",
10 "division" : null,
11 "folderId" : "00DD000000086ujMAA",
12 "groupingsAcross" : [ ],
13 "groupingsDown" : [ ],
14 "hasDetailRows" : true,
15 "hasRecordCount" : true,
16 "historicalSnapshotDates" : [ ],
17 "id" : "00OD0000001leVCMAY",
18 "name" : "Matrix",
19 "reportBooleanFilter" : null,
20 "reportFilters" : [ ],
21 "reportFormat" : "MATRIX",
22 "reportType" : {
23 "label" : "Opportunities",
24 "type" : "Opportunity"
25 },
26 "scope" : "organization",
27 "showGrandTotal" : true,
28 "showSubtotals" : true,
29 "sortBy" : [ ],
30 "standardDateFilter" : {
31 "column" : "CLOSE_DATE",
32 "durationValue" : "CUSTOM",
33 "endDate" : null,
34 "startDate" : null
35 },
36 "standardFilters" : [ {
37 "name" : "open",
38 "value" : "all"
39 }, {
40 "name" : "probability",
41 "value" : ">0"
42 } ]
43 }
44}The response to the POST request returns report data, but doesn’t create or save a report.
1{
2 "attributes" : {
3 "describeUrl" : "/services/data/v37.0/analytics/reports/null/describe",
4 "instancesUrl" : "/services/data/v37.0/analytics/reports/null/instances",
5 "reportId" : null,
6 "reportName" : "Matrix",
7 "type" : "Report"
8 },
9 "allData" : true,
10 "factMap" : {
11 "T!T" : {
12 "aggregates" : [ {
13 "label" : "9",
14 "value" : 9
15 } ],
16 "rows" : [ {
17 "dataCells" : [ {
18 "label" : "salesforce.com - 5000 Widgets",
19 "value" : "006D000000CzmqYIAR"
20 }, {
21 "label" : "New Business",
22 "value" : "New Business"
23 }, {
24 "label" : "Advertisement",
25 "value" : "Advertisement"
26 }, {
27 "label" : "$500,000.00",
28 "value" : {
29 "amount" : 500000,
30 "currency" : null
31 }
32 }, {
33 "label" : "9/19/2013",
34 "value" : "2013-09-19"
35 }, {
36 "label" : "Closed!",
37 "value" : "Closed!"
38 }, {
39 "label" : "Closed Won",
40 "value" : "Closed Won"
41 }, {
42 "label" : "100%",
43 "value" : 100
44 }, {
45 "label" : "Q2-2007",
46 "value" : "Q2-2007"
47 }, {
48 "label" : "0",
49 "value" : 0
50 }, {
51 "label" : "1/4/2016",
52 "value" : "2016-01-04"
53 }, {
54 "label" : "Fred Williamson",
55 "value" : "005D0000001bV42IAE"
56 }, {
57 "label" : "-",
58 "value" : null
59 }, {
60 "label" : "Global Media",
61 "value" : "001D000000KtTTqIAN"
62 } ]
63 }, {
64 "dataCells" : [ {
65 "label" : "salesforce.com - 500 Widgets",
66 "value" : "006D000000CzmqZIAR"
67 }, {
68 "label" : "Existing Business",
69 "value" : "Existing Business"
70 }, {
71 "label" : "Advertisement",
72 "value" : "Advertisement"
73 }, {
74 "label" : "$50,000.00",
75 "value" : {
76 "amount" : 50000,
77 "currency" : null
78 }
79 }, {
80 "label" : "9/19/2013",
81 "value" : "2013-09-19"
82 }, {
83 "label" : "Closed!",
84 "value" : "Closed!"
85 }, {
86 "label" : "Closed Won",
87 "value" : "Closed Won"
88 }, {
89 "label" : "100%",
90 "value" : 100
91 }, {
92 "label" : "Q2-2007",
93 "value" : "Q2-2007"
94 }, {
95 "label" : "0",
96 "value" : 0
97 }, {
98 "label" : "1/4/2016",
99 "value" : "2016-01-04"
100 }, {
101 "label" : "Fred Williamson",
102 "value" : "005D0000001bV42IAE"
103 }, {
104 "label" : "-",
105 "value" : null
106 }, {
107 "label" : "Global Media",
108 "value" : "001D000000KtTTqIAN"
109 } ]
110 }, {
111 "dataCells" : [ {
112 "label" : "Acme - 1,200 Widgets",
113 "value" : "006D000000CzmqbIAB"
114 }, {
115 "label" : "Existing Business",
116 "value" : "Existing Business"
117 }, {
118 "label" : "Trade Show",
119 "value" : "Trade Show"
120 }, {
121 "label" : "$140,000.00",
122 "value" : {
123 "amount" : 140000,
124 "currency" : null
125 }
126 }, {
127 "label" : "10/22/2013",
128 "value" : "2013-10-22"
129 }, {
130 "label" : "Need estimate",
131 "value" : "Need estimate"
132 }, {
133 "label" : "Value Proposition",
134 "value" : "Value Proposition"
135 }, {
136 "label" : "50%",
137 "value" : 50
138 }, {
139 "label" : "Q2-2007",
140 "value" : "Q2-2007"
141 }, {
142 "label" : "134",
143 "value" : 134
144 }, {
145 "label" : "1/4/2016",
146 "value" : "2016-01-04"
147 }, {
148 "label" : "Fred Williamson",
149 "value" : "005D0000001bV42IAE"
150 }, {
151 "label" : "-",
152 "value" : null
153 }, {
154 "label" : "Acme",
155 "value" : "001D000000KtTTrIAN"
156 } ]
157 }, {
158 "dataCells" : [ {
159 "label" : "salesforce.com - 1,000 Widgets",
160 "value" : "006D000000CzmqeIAB"
161 }, {
162 "label" : "New Business",
163 "value" : "New Business"
164 }, {
165 "label" : "Advertisement",
166 "value" : "Advertisement"
167 }, {
168 "label" : "$100,000.00",
169 "value" : {
170 "amount" : 100000,
171 "currency" : null
172 }
173 }, {
174 "label" : "10/22/2013",
175 "value" : "2013-10-22"
176 }, {
177 "label" : "Close the deal!",
178 "value" : "Close the deal!"
179 }, {
180 "label" : "Negotiation/Review",
181 "value" : "Negotiation/Review"
182 }, {
183 "label" : "90%",
184 "value" : 90
185 }, {
186 "label" : "Q2-2007",
187 "value" : "Q2-2007"
188 }, {
189 "label" : "134",
190 "value" : 134
191 }, {
192 "label" : "1/4/2016",
193 "value" : "2016-01-04"
194 }, {
195 "label" : "Fred Williamson",
196 "value" : "005D0000001bV42IAE"
197 }, {
198 "label" : "-",
199 "value" : null
200 }, {
201 "label" : "salesforce.com",
202 "value" : "001D000000KtTTsIAN"
203 } ]
204 }, {
205 "dataCells" : [ {
206 "label" : "Global Media - 400 Widgets",
207 "value" : "006D000000CzmqaIAB"
208 }, {
209 "label" : "New Business",
210 "value" : "New Business"
211 }, {
212 "label" : "Partner",
213 "value" : "Partner"
214 }, {
215 "label" : "$40,000.00",
216 "value" : {
217 "amount" : 40000,
218 "currency" : null
219 }
220 }, {
221 "label" : "11/20/2013",
222 "value" : "2013-11-20"
223 }, {
224 "label" : "-",
225 "value" : null
226 }, {
227 "label" : "Id. Decision Makers",
228 "value" : "Id. Decision Makers"
229 }, {
230 "label" : "60%",
231 "value" : 60
232 }, {
233 "label" : "Q3-2007",
234 "value" : "Q3-2007"
235 }, {
236 "label" : "134",
237 "value" : 134
238 }, {
239 "label" : "1/4/2016",
240 "value" : "2016-01-04"
241 }, {
242 "label" : "Fred Williamson",
243 "value" : "005D0000001bV42IAE"
244 }, {
245 "label" : "-",
246 "value" : null
247 }, {
248 "label" : "Global Media",
249 "value" : "001D000000KtTTqIAN"
250 } ]
251 }, {
252 "dataCells" : [ {
253 "label" : "Acme - 600 Widgets",
254 "value" : "006D000000CzmqcIAB"
255 }, {
256 "label" : "New Business",
257 "value" : "New Business"
258 }, {
259 "label" : "Trade Show",
260 "value" : "Trade Show"
261 }, {
262 "label" : "$70,000.00",
263 "value" : {
264 "amount" : 70000,
265 "currency" : null
266 }
267 }, {
268 "label" : "12/18/2013",
269 "value" : "2013-12-18"
270 }, {
271 "label" : "Need estimate",
272 "value" : "Need estimate"
273 }, {
274 "label" : "Needs Analysis",
275 "value" : "Needs Analysis"
276 }, {
277 "label" : "20%",
278 "value" : 20
279 }, {
280 "label" : "Q3-2007",
281 "value" : "Q3-2007"
282 }, {
283 "label" : "134",
284 "value" : 134
285 }, {
286 "label" : "1/4/2016",
287 "value" : "2016-01-04"
288 }, {
289 "label" : "Fred Williamson",
290 "value" : "005D0000001bV42IAE"
291 }, {
292 "label" : "-",
293 "value" : null
294 }, {
295 "label" : "Acme",
296 "value" : "001D000000KtTTrIAN"
297 } ]
298 }, {
299 "dataCells" : [ {
300 "label" : "salesforce.com - 2,000 Widgets",
301 "value" : "006D000000CzmqfIAB"
302 }, {
303 "label" : "Existing Business",
304 "value" : "Existing Business"
305 }, {
306 "label" : "Partner",
307 "value" : "Partner"
308 }, {
309 "label" : "$20,000.00",
310 "value" : {
311 "amount" : 20000,
312 "currency" : null
313 }
314 }, {
315 "label" : "12/20/2013",
316 "value" : "2013-12-20"
317 }, {
318 "label" : "Meet at Widget Conference",
319 "value" : "Meet at Widget Conference"
320 }, {
321 "label" : "Value Proposition",
322 "value" : "Value Proposition"
323 }, {
324 "label" : "50%",
325 "value" : 50
326 }, {
327 "label" : "Q3-2007",
328 "value" : "Q3-2007"
329 }, {
330 "label" : "134",
331 "value" : 134
332 }, {
333 "label" : "1/4/2016",
334 "value" : "2016-01-04"
335 }, {
336 "label" : "Fred Williamson",
337 "value" : "005D0000001bV42IAE"
338 }, {
339 "label" : "-",
340 "value" : null
341 }, {
342 "label" : "salesforce.com",
343 "value" : "001D000000KtTTsIAN"
344 } ]
345 }, {
346 "dataCells" : [ {
347 "label" : "Acme - 200 Widgets",
348 "value" : "006D000000CzmqdIAB"
349 }, {
350 "label" : "Existing Business",
351 "value" : "Existing Business"
352 }, {
353 "label" : "Word of mouth",
354 "value" : "Word of mouth"
355 }, {
356 "label" : "$20,000.00",
357 "value" : {
358 "amount" : 20000,
359 "currency" : null
360 }
361 }, {
362 "label" : "2/20/2014",
363 "value" : "2014-02-20"
364 }, {
365 "label" : "Need estimate",
366 "value" : "Need estimate"
367 }, {
368 "label" : "Prospecting",
369 "value" : "Prospecting"
370 }, {
371 "label" : "10%",
372 "value" : 10
373 }, {
374 "label" : "Q4-2007",
375 "value" : "Q4-2007"
376 }, {
377 "label" : "134",
378 "value" : 134
379 }, {
380 "label" : "1/4/2016",
381 "value" : "2016-01-04"
382 }, {
383 "label" : "Fred Williamson",
384 "value" : "005D0000001bV42IAE"
385 }, {
386 "label" : "-",
387 "value" : null
388 }, {
389 "label" : "Acme",
390 "value" : "001D000000KtTTrIAN"
391 } ]
392 }, {
393 "dataCells" : [ {
394 "label" : "Fred",
395 "value" : "006D000000Czq0uIAB"
396 }, {
397 "label" : "-",
398 "value" : null
399 }, {
400 "label" : "-",
401 "value" : null
402 }, {
403 "label" : "-",
404 "value" : null
405 }, {
406 "label" : "2/26/2016",
407 "value" : "2016-02-26"
408 }, {
409 "label" : "-",
410 "value" : null
411 }, {
412 "label" : "Id. Decision Makers",
413 "value" : "Id. Decision Makers"
414 }, {
415 "label" : "60%",
416 "value" : 60
417 }, {
418 "label" : "Q1-2016",
419 "value" : "Q1-2016"
420 }, {
421 "label" : "85",
422 "value" : 85
423 }, {
424 "label" : "2/22/2016",
425 "value" : "2016-02-22"
426 }, {
427 "label" : "Fred Williamson",
428 "value" : "005D0000001bV42IAE"
429 }, {
430 "label" : "-",
431 "value" : null
432 }, {
433 "label" : "Fred",
434 "value" : "001D000000KtqzeIAB"
435 } ]
436 } ]
437 }
438 },
439 "groupingsAcross" : {
440 "groupings" : [ ]
441 },
442 "groupingsDown" : {
443 "groupings" : [ ]
444 },
445 "hasDetailRows" : true,
446 "reportExtendedMetadata" : {
447 "aggregateColumnInfo" : {
448 "RowCount" : {
449 "dataType" : "int",
450 "label" : "Record Count"
451 }
452 },
453 "detailColumnInfo" : {
454 "OPPORTUNITY_NAME" : {
455 "dataType" : "string",
456 "label" : "Opportunity Name"
457 },
458 "TYPE" : {
459 "dataType" : "picklist",
460 "label" : "Type"
461 },
462 "LEAD_SOURCE" : {
463 "dataType" : "picklist",
464 "label" : "Lead Source"
465 },
466 "AMOUNT" : {
467 "dataType" : "currency",
468 "label" : "Amount"
469 },
470 "CLOSE_DATE" : {
471 "dataType" : "date",
472 "label" : "Close Date"
473 },
474 "NEXT_STEP" : {
475 "dataType" : "string",
476 "label" : "Next Step"
477 },
478 "STAGE_NAME" : {
479 "dataType" : "picklist",
480 "label" : "Stage"
481 },
482 "PROBABILITY" : {
483 "dataType" : "percent",
484 "label" : "Probability (%)"
485 },
486 "FISCAL_QUARTER" : {
487 "dataType" : "string",
488 "label" : "Fiscal Period"
489 },
490 "AGE" : {
491 "dataType" : "int",
492 "label" : "Age"
493 },
494 "CREATED_DATE" : {
495 "dataType" : "datetime",
496 "label" : "Created Date"
497 },
498 "FULL_NAME" : {
499 "dataType" : "string",
500 "label" : "Opportunity Owner"
501 },
502 "ROLLUP_DESCRIPTION" : {
503 "dataType" : "string",
504 "label" : "Owner Role"
505 },
506 "ACCOUNT_NAME" : {
507 "dataType" : "string",
508 "label" : "Account Name"
509 }
510 },
511 "groupingColumnInfo" : { }
512 },
513 "reportMetadata" : {
514 "aggregates" : [ "RowCount" ],
515 "chart" : null,
516 "crossFilters" : [ ],
517 "currency" : null,
518 "description" : null,
519 "detailColumns" : [ "OPPORTUNITY_NAME", "TYPE", "LEAD_SOURCE", "AMOUNT", "CLOSE_DATE", "NEXT_STEP", "STAGE_NAME", "PROBABILITY", "FISCAL_QUARTER", "AGE", "CREATED_DATE", "FULL_NAME", "ROLLUP_DESCRIPTION", "ACCOUNT_NAME" ],
520 "developerName" : null,
521 "division" : null,
522 "folderId" : "00DD000000086ujMAA",
523 "groupingsAcross" : [ ],
524 "groupingsDown" : [ ],
525 "hasDetailRows" : true,
526 "hasRecordCount" : true,
527 "historicalSnapshotDates" : [ ],
528 "id" : null,
529 "name" : "Matrix",
530 "reportBooleanFilter" : null,
531 "reportFilters" : [ ],
532 "reportFormat" : "TABULAR",
533 "reportType" : {
534 "label" : "Opportunities",
535 "type" : "Opportunity"
536 },
537 "scope" : "organization",
538 "showGrandTotal" : true,
539 "showSubtotals" : true,
540 "sortBy" : [ ],
541 "standardDateFilter" : {
542 "column" : "CLOSE_DATE",
543 "durationValue" : "CUSTOM",
544 "endDate" : null,
545 "startDate" : null
546 },
547 "standardFilters" : [ {
548 "name" : "open",
549 "value" : "all"
550 }, {
551 "name" : "probability",
552 "value" : ">0"
553 } ]
554 }
555}