Reports API Resource Reference

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.

As of API version 43.0, if your org turns on the Lightning Experience joined report beta, then you can use the Reports REST API to work with joined reports. For more information about the Lightning Experience joined report beta, including how to opt in, see Enable Lightning Joined Reports (Beta) in Salesforce help.

A report is a joined report when reportFormat is MULTI_BLOCK.

As you get ready to work with joined reports in the REST API, take note of these beta limitations and known issues.

If you make a POST or PATCH request on a joined report to edit the report, only some properties can be edited:
- hasDetailRows
- hasRecordCount
- showSubtotals
- showGrandTotal
If you make a POST or PATCH request on a joined report and try to change reportFormat then you get a success code but reportFormat isn’t updated.
You can’t change reportFormat to MULTI_BLOCK.

As a beta feature, Lightning Experience joined reports is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature.

Note

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 Sync	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.
Execute 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.

Salesforce Reports and Dashboards REST API Developer Guide

Reports API Resource Reference