Salesforce Reports and Dashboards REST API Developer Guide
jNewer Version Available
Report Fields
The Report Fields resource returns report fields available for specified reports. Use
the resource to determine the best fields for use in dashboard filters by seeing which fields
different source reports have in common. Available in API version 40.0 and later.
Resource URL
1/services/data/<latest API version>/analytics/reports/<report ID>/fieldsFormats
JSON
HTTP Methods
| Method | Description |
|---|---|
| POST | If the request body is empty, returns a list of all possible report fields. Otherwise, returns a list of fields that specified reports share. |
POST Request Body
| Property | Type | Description |
|---|---|---|
| intersectWith | Array of Report IDs | An array of unique report IDs. |
POST Response Body
| Property | Type | Description |
|---|---|---|
| displayGroups | Array of Fields | Fields available when adding a filter. |
| equivalentFields | Array of Fields | Fields available for each specified report. Each object in this array is a list of common fields categorized by report type. |
| equivalentFieldIndices | Map of Fields | Map of each field’s API name to the index of the field in the equivalentFields array. |
| mergedGroups | Array of Fields | Merged fields. |
Example Request Body
1{
2 "intersectWith": ["00OR0000000P3RVMA0"]
3}Example Response Body
1{
2 "displayGroups" : {
3 "Opportunity" : [ {
4 "columns" : {
5 "ACCOUNT_CREATED_DATE" : {
6 "dataType" : "date",
7 "filterValues" : [ ],
8 "filterable" : true,
9 "isLookup" : false,
10 "label" : "Account: Created Date",
11 "maxLength" : null
12 },
13 "ACCOUNT_LAST_ACTIVITY" : {
14 "dataType" : "date",
15 "filterValues" : [ ],
16 "filterable" : true,
17 "isLookup" : false,
18 "label" : "Account: Last Activity",
19 "maxLength" : null
20 },
21 "ACCOUNT_LAST_UPDATE" : {
22 "dataType" : "date",
23 "filterValues" : [ ],
24 "filterable" : true,
25 "isLookup" : false,
26 "label" : "Account: Last Modified Date",
27 "maxLength" : null
28 },
29 "ACCOUNT_OWNER" : {
30 "dataType" : "string",
31 "filterValues" : [ ],
32 "filterable" : true,
33 "isLookup" : false,
34 "label" : "Account Owner",
35 "maxLength" : null
36 },
37 "ACCOUNT_OWNER_ALIAS" : {
38 "dataType" : "string",
39 "filterValues" : [ ],
40 "filterable" : true,
41 "isLookup" : true,
42 "label" : "Account Owner Alias",
43 "maxLength" : 8
44 }
45 },
46 "label" : "Account: General",
47 "labelSuffix" : "(Opportunities)"
48 }, {
49 "columns" : {
50 "CLOSE_DATE" : {
51 "dataType" : "date",
52 "filterValues" : [ ],
53 "filterable" : true,
54 "isLookup" : false,
55 "label" : "Close Date",
56 "maxLength" : null
57 },
58 "CLOSE_DATE2" : {
59 "dataType" : "date",
60 "filterValues" : [ ],
61 "filterable" : true,
62 "isLookup" : false,
63 "label" : "Close Date (2)",
64 "maxLength" : null
65 },
66 "CLOSE_MONTH" : {
67 "dataType" : "date",
68 "filterValues" : [ ],
69 "filterable" : true,
70 "isLookup" : false,
71 "label" : "Close Month",
72 "maxLength" : null
73 },
74 "CREATED_ALIAS" : {
75 "dataType" : "string",
76 "filterValues" : [ ],
77 "filterable" : true,
78 "isLookup" : true,
79 "label" : "Created Alias",
80 "maxLength" : 8
81 },
82 "CREATED" : {
83 "dataType" : "string",
84 "filterValues" : [ ],
85 "filterable" : true,
86 "isLookup" : false,
87 "label" : "Created By",
88 "maxLength" : null
89 },
90 "CREATED_DATE" : {
91 "dataType" : "date",
92 "filterValues" : [ ],
93 "filterable" : true,
94 "isLookup" : false,
95 "label" : "Created Date",
96 "maxLength" : null
97 },
98 "LAST_ACTIVITY" : {
99 "dataType" : "date",
100 "filterValues" : [ ],
101 "filterable" : true,
102 "isLookup" : false,
103 "label" : "Last Activity",
104 "maxLength" : null
105 },
106 "LAST_UPDATE_BY_ALIAS" : {
107 "dataType" : "string",
108 "filterValues" : [ ],
109 "filterable" : true,
110 "isLookup" : true,
111 "label" : "Last Modified Alias",
112 "maxLength" : 8
113 },
114 "LAST_UPDATE_BY" : {
115 "dataType" : "string",
116 "filterValues" : [ ],
117 "filterable" : true,
118 "isLookup" : false,
119 "label" : "Last Modified By",
120 "maxLength" : null
121 },
122 "LAST_UPDATE" : {
123 "dataType" : "date",
124 "filterValues" : [ ],
125 "filterable" : true,
126 "isLookup" : false,
127 "label" : "Last Modified Date",
128 "maxLength" : null
129 },
130 "LAST_STAGE_CHANGE_DATE" : {
131 "dataType" : "date",
132 "filterValues" : [ ],
133 "filterable" : true,
134 "isLookup" : false,
135 "label" : "Last Stage Change Date",
136 "maxLength" : null
137 }
138 },
139 "label" : "Opportunity Information",
140 "labelSuffix" : "(Opportunities)"
141 }, {
142 "columns" : {
143 "FULL_NAME" : {
144 "dataType" : "string",
145 "filterValues" : [ ],
146 "filterable" : true,
147 "isLookup" : false,
148 "label" : "Opportunity Owner",
149 "maxLength" : null
150 },
151 "OWNER_MANAGER" : {
152 "dataType" : "string",
153 "filterValues" : [ ],
154 "filterable" : true,
155 "isLookup" : false,
156 "label" : "Opportunity Owner: Manager",
157 "maxLength" : null
158 },
159 "ALIAS" : {
160 "dataType" : "string",
161 "filterValues" : [ ],
162 "filterable" : true,
163 "isLookup" : true,
164 "label" : "Opportunity Owner Alias",
165 "maxLength" : 8
166 },
167 "ROLLUP_DESCRIPTION" : {
168 "dataType" : "string",
169 "filterValues" : [ ],
170 "filterable" : true,
171 "isLookup" : true,
172 "label" : "Owner Role",
173 "maxLength" : 80
174 }
175 },
176 "label" : "Opportunity Owner Information",
177 "labelSuffix" : "(Opportunities)"
178 } ],
179 "LeadList" : [ {
180 "columns" : {
181 "EMAIL_BOUNCED_DATE" : {
182 "dataType" : "datetime",
183 "filterValues" : [ ],
184 "filterable" : true,
185 "isLookup" : false,
186 "label" : "Email Bounced Date",
187 "maxLength" : null
188 }
189 },
190 "label" : "Lead: Ph/Fax/Email",
191 "labelSuffix" : "(Leads)"
192 }, {
193 "columns" : {
194 "CREATED_ALIAS" : {
195 "dataType" : "string",
196 "filterValues" : [ ],
197 "filterable" : true,
198 "isLookup" : true,
199 "label" : "Created Alias",
200 "maxLength" : 8
201 },
202 "CREATED_DATE" : {
203 "dataType" : "date",
204 "filterValues" : [ ],
205 "filterable" : true,
206 "isLookup" : false,
207 "label" : "Create Date",
208 "maxLength" : null
209 },
210 "CREATED" : {
211 "dataType" : "string",
212 "filterValues" : [ ],
213 "filterable" : true,
214 "isLookup" : false,
215 "label" : "Created By",
216 "maxLength" : null
217 },
218 "CREATED_MONTH" : {
219 "dataType" : "date",
220 "filterValues" : [ ],
221 "filterable" : true,
222 "isLookup" : false,
223 "label" : "Created Month",
224 "maxLength" : null
225 },
226 "LAST_ACTIVITY" : {
227 "dataType" : "date",
228 "filterValues" : [ ],
229 "filterable" : true,
230 "isLookup" : false,
231 "label" : "Last Activity",
232 "maxLength" : null
233 },
234 "LAST_UPDATE" : {
235 "dataType" : "date",
236 "filterValues" : [ ],
237 "filterable" : true,
238 "isLookup" : false,
239 "label" : "Last Modified",
240 "maxLength" : null
241 },
242 "LAST_UPDATE_BY_ALIAS" : {
243 "dataType" : "string",
244 "filterValues" : [ ],
245 "filterable" : true,
246 "isLookup" : true,
247 "label" : "Last Modified Alias",
248 "maxLength" : 8
249 },
250 "LAST_UPDATE_BY" : {
251 "dataType" : "string",
252 "filterValues" : [ ],
253 "filterable" : true,
254 "isLookup" : false,
255 "label" : "Last Modified By",
256 "maxLength" : null
257 },
258 "OWNER_ROLE_DISPLAY" : {
259 "dataType" : "string",
260 "filterValues" : [ ],
261 "filterable" : true,
262 "isLookup" : true,
263 "label" : "Owner Role Display",
264 "maxLength" : 80
265 }
266 },
267 "label" : "Lead General",
268 "labelSuffix" : "(Leads)"
269 } ]
270 },
271 "equivalentFieldIndices" : {
272 "ACCOUNT_CREATED_DATE" : 19,
273 "ACCOUNT_LAST_UPDATE" : 19,
274 "ACCOUNT_OWNER" : 15,
275 "CREATED_ALIAS" : 16,
276 "CREATED_DATE" : 19,
277 "LAST_UPDATE_BY_ALIAS" : 16,
278 "ALIAS" : 16,
279 "EMAIL_BOUNCED_DATE" : 19,
280 "CLOSE_MONTH" : 17,
281 "LAST_UPDATE_BY" : 15,
282 "CREATED_MONTH" : 17,
283 "LAST_ACTIVITY" : 17,
284 "ACCOUNT_LAST_ACTIVITY" : 17,
285 "CLOSE_DATE" : 17,
286 "CREATED" : 15,
287 "LAST_UPDATE" : 19,
288 "CLOSE_DATE2" : 17,
289 "OWNER_MANAGER" : 15,
290 "LAST_STAGE_CHANGE_DATE" : 19,
291 "ROLLUP_DESCRIPTION" : 7,
292 "FULL_NAME" : 15,
293 "ACCOUNT_OWNER_ALIAS" : 16,
294 "OWNER_ROLE_DISPLAY" : 7
295 },
296 "equivalentFields" : [ {
297 "LeadList" : [ {
298 "name" : "CREATED"
299 }, {
300 "name" : "LAST_UPDATE_BY"
301 } ],
302 "Opportunity" : [ {
303 "name" : "CREATED"
304 }, {
305 "name" : "LAST_UPDATE_BY"
306 }, {
307 "name" : "FULL_NAME"
308 }, {
309 "name" : "OWNER_MANAGER"
310 }, {
311 "name" : "ACCOUNT_OWNER"
312 } ]
313 }, {
314 "LeadList" : [ {
315 "name" : "CREATED_ALIAS"
316 }, {
317 "name" : "LAST_UPDATE_BY_ALIAS"
318 } ],
319 "Opportunity" : [ {
320 "name" : "CREATED_ALIAS"
321 }, {
322 "name" : "LAST_UPDATE_BY_ALIAS"
323 }, {
324 "name" : "ALIAS"
325 }, {
326 "name" : "ACCOUNT_OWNER_ALIAS"
327 } ]
328 }, {
329 "LeadList" : [ {
330 "name" : "LAST_UPDATE_BY"
331 }, {
332 "name" : "CREATED"
333 } ],
334 "Opportunity" : [ {
335 "name" : "LAST_UPDATE_BY"
336 }, {
337 "name" : "CREATED"
338 }, {
339 "name" : "FULL_NAME"
340 }, {
341 "name" : "OWNER_MANAGER"
342 }, {
343 "name" : "ACCOUNT_OWNER"
344 } ]
345 }, {
346 "LeadList" : [ {
347 "name" : "LAST_UPDATE_BY_ALIAS"
348 }, {
349 "name" : "CREATED_ALIAS"
350 } ],
351 "Opportunity" : [ {
352 "name" : "LAST_UPDATE_BY_ALIAS"
353 }, {
354 "name" : "CREATED_ALIAS"
355 }, {
356 "name" : "ALIAS"
357 }, {
358 "name" : "ACCOUNT_OWNER_ALIAS"
359 } ]
360 }, {
361 "LeadList" : [ {
362 "name" : "CREATED_DATE"
363 }, {
364 "name" : "LAST_UPDATE"
365 }, {
366 "name" : "EMAIL_BOUNCED_DATE"
367 } ],
368 "Opportunity" : [ {
369 "name" : "CREATED_DATE"
370 }, {
371 "name" : "LAST_STAGE_CHANGE_DATE"
372 }, {
373 "name" : "LAST_UPDATE"
374 }, {
375 "name" : "ACCOUNT_CREATED_DATE"
376 }, {
377 "name" : "ACCOUNT_LAST_UPDATE"
378 } ]
379 }, {
380 "LeadList" : [ {
381 "name" : "CREATED_MONTH"
382 }, {
383 "name" : "LAST_ACTIVITY"
384 } ],
385 "Opportunity" : [ {
386 "name" : "CLOSE_DATE"
387 }, {
388 "name" : "CLOSE_DATE2"
389 }, {
390 "name" : "CLOSE_MONTH"
391 }, {
392 "name" : "LAST_ACTIVITY"
393 }, {
394 "name" : "ACCOUNT_LAST_ACTIVITY"
395 } ]
396 }, {
397 "LeadList" : [ {
398 "name" : "LAST_UPDATE"
399 }, {
400 "name" : "CREATED_DATE"
401 }, {
402 "name" : "EMAIL_BOUNCED_DATE"
403 } ],
404 "Opportunity" : [ {
405 "name" : "LAST_UPDATE"
406 }, {
407 "name" : "LAST_STAGE_CHANGE_DATE"
408 }, {
409 "name" : "CREATED_DATE"
410 }, {
411 "name" : "ACCOUNT_CREATED_DATE"
412 }, {
413 "name" : "ACCOUNT_LAST_UPDATE"
414 } ]
415 }, {
416 "LeadList" : [ {
417 "name" : "OWNER_ROLE_DISPLAY"
418 } ],
419 "Opportunity" : [ {
420 "name" : "ROLLUP_DESCRIPTION"
421 } ]
422 }, {
423 "LeadList" : [ {
424 "name" : "LAST_ACTIVITY"
425 }, {
426 "name" : "CREATED_MONTH"
427 } ],
428 "Opportunity" : [ {
429 "name" : "LAST_ACTIVITY"
430 }, {
431 "name" : "CLOSE_DATE"
432 }, {
433 "name" : "CLOSE_DATE2"
434 }, {
435 "name" : "CLOSE_MONTH"
436 }, {
437 "name" : "ACCOUNT_LAST_ACTIVITY"
438 } ]
439 }, {
440 "LeadList" : [ {
441 "name" : "EMAIL_BOUNCED_DATE"
442 }, {
443 "name" : "CREATED_DATE"
444 }, {
445 "name" : "LAST_UPDATE"
446 } ],
447 "Opportunity" : [ {
448 "name" : "LAST_STAGE_CHANGE_DATE"
449 }, {
450 "name" : "CREATED_DATE"
451 }, {
452 "name" : "LAST_UPDATE"
453 }, {
454 "name" : "ACCOUNT_CREATED_DATE"
455 }, {
456 "name" : "ACCOUNT_LAST_UPDATE"
457 } ]
458 }, {
459 "LeadList" : [ {
460 "name" : "LAST_ACTIVITY"
461 }, {
462 "name" : "CREATED_MONTH"
463 } ],
464 "Opportunity" : [ {
465 "name" : "CLOSE_DATE2"
466 }, {
467 "name" : "CLOSE_DATE"
468 }, {
469 "name" : "CLOSE_MONTH"
470 }, {
471 "name" : "LAST_ACTIVITY"
472 }, {
473 "name" : "ACCOUNT_LAST_ACTIVITY"
474 } ]
475 }, {
476 "LeadList" : [ {
477 "name" : "LAST_ACTIVITY"
478 }, {
479 "name" : "CREATED_MONTH"
480 } ],
481 "Opportunity" : [ {
482 "name" : "CLOSE_MONTH"
483 }, {
484 "name" : "CLOSE_DATE"
485 }, {
486 "name" : "CLOSE_DATE2"
487 }, {
488 "name" : "LAST_ACTIVITY"
489 }, {
490 "name" : "ACCOUNT_LAST_ACTIVITY"
491 } ]
492 }, {
493 "LeadList" : [ {
494 "name" : "CREATED"
495 }, {
496 "name" : "LAST_UPDATE_BY"
497 } ],
498 "Opportunity" : [ {
499 "name" : "FULL_NAME"
500 }, {
501 "name" : "CREATED"
502 }, {
503 "name" : "LAST_UPDATE_BY"
504 }, {
505 "name" : "OWNER_MANAGER"
506 }, {
507 "name" : "ACCOUNT_OWNER"
508 } ]
509 }, {
510 "LeadList" : [ {
511 "name" : "CREATED_ALIAS"
512 }, {
513 "name" : "LAST_UPDATE_BY_ALIAS"
514 } ],
515 "Opportunity" : [ {
516 "name" : "ALIAS"
517 }, {
518 "name" : "CREATED_ALIAS"
519 }, {
520 "name" : "LAST_UPDATE_BY_ALIAS"
521 }, {
522 "name" : "ACCOUNT_OWNER_ALIAS"
523 } ]
524 }, {
525 "LeadList" : [ {
526 "name" : "CREATED"
527 }, {
528 "name" : "LAST_UPDATE_BY"
529 } ],
530 "Opportunity" : [ {
531 "name" : "OWNER_MANAGER"
532 }, {
533 "name" : "CREATED"
534 }, {
535 "name" : "LAST_UPDATE_BY"
536 }, {
537 "name" : "FULL_NAME"
538 }, {
539 "name" : "ACCOUNT_OWNER"
540 } ]
541 }, {
542 "LeadList" : [ {
543 "name" : "CREATED"
544 }, {
545 "name" : "LAST_UPDATE_BY"
546 } ],
547 "Opportunity" : [ {
548 "name" : "ACCOUNT_OWNER"
549 }, {
550 "name" : "CREATED"
551 }, {
552 "name" : "LAST_UPDATE_BY"
553 }, {
554 "name" : "FULL_NAME"
555 }, {
556 "name" : "OWNER_MANAGER"
557 } ]
558 }, {
559 "LeadList" : [ {
560 "name" : "CREATED_ALIAS"
561 }, {
562 "name" : "LAST_UPDATE_BY_ALIAS"
563 } ],
564 "Opportunity" : [ {
565 "name" : "ACCOUNT_OWNER_ALIAS"
566 }, {
567 "name" : "CREATED_ALIAS"
568 }, {
569 "name" : "LAST_UPDATE_BY_ALIAS"
570 }, {
571 "name" : "ALIAS"
572 } ]
573 }, {
574 "LeadList" : [ {
575 "name" : "LAST_ACTIVITY"
576 }, {
577 "name" : "CREATED_MONTH"
578 } ],
579 "Opportunity" : [ {
580 "name" : "ACCOUNT_LAST_ACTIVITY"
581 }, {
582 "name" : "CLOSE_DATE"
583 }, {
584 "name" : "CLOSE_DATE2"
585 }, {
586 "name" : "CLOSE_MONTH"
587 }, {
588 "name" : "LAST_ACTIVITY"
589 } ]
590 }, {
591 "LeadList" : [ {
592 "name" : "CREATED_DATE"
593 }, {
594 "name" : "LAST_UPDATE"
595 }, {
596 "name" : "EMAIL_BOUNCED_DATE"
597 } ],
598 "Opportunity" : [ {
599 "name" : "ACCOUNT_CREATED_DATE"
600 }, {
601 "name" : "LAST_STAGE_CHANGE_DATE"
602 }, {
603 "name" : "CREATED_DATE"
604 }, {
605 "name" : "LAST_UPDATE"
606 }, {
607 "name" : "ACCOUNT_LAST_UPDATE"
608 } ]
609 }, {
610 "LeadList" : [ {
611 "name" : "CREATED_DATE"
612 }, {
613 "name" : "LAST_UPDATE"
614 }, {
615 "name" : "EMAIL_BOUNCED_DATE"
616 } ],
617 "Opportunity" : [ {
618 "name" : "ACCOUNT_LAST_UPDATE"
619 }, {
620 "name" : "LAST_STAGE_CHANGE_DATE"
621 }, {
622 "name" : "CREATED_DATE"
623 }, {
624 "name" : "LAST_UPDATE"
625 }, {
626 "name" : "ACCOUNT_CREATED_DATE"
627 } ]
628 } ],
629 "mergedGroups" : { }
630}