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
Formats
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. |