Note: 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.
Reports
Resources for the Reports API are available at /services/data/<latest API version>/analytics/reports. You can query each resource with a HTTP
method (such as GET). Use these resources to integrate report data
directly into your applications.
| Resource | Supported HTTP Method | Description |
|---|---|---|
| Report | PATCH, DELETE | Saves changes to a report. Deletes a report. |
| Describe | GET | Gives report metadata. This includes information about fields that are defined in the report as detail columns, summaries, custom summary formulas, filters, and groupings. |
| Execute Syte | GET, POST | Gives report summary level data with or without details. Returns specific results if you define dynamic filters, groupings, or aggregates in the metadata of a POST request. |
| Exexcute Async | POST | Returns an instance that stores summary level data with or without details for a report run asynchronously. To get specific results, define filters in the metadata of the request. |
| Instances List | GET | List of instances of a report that were requested for an asynchronous run. |
| Instance Results | GET | Depending on the type of your request, gives summary level data with or without details for an instance of a report run asynchronously. |
| Report List | GET, POST | List of reports that were recently viewed by the API user. Makes a copy of a report. |
| Report Fields | 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. Use the fields resource to determine the best fields for use in dashboard filters. |