Salesforce Reports and Dashboards REST API Developer Guide

Salesforce Reports and Dashboards REST API
Examples: Reports REST API Resources
Create a New Report
Run Reports Synchronously or Asynchronously
Get Report Metadata
Get a List of Report Types
Download Formatted Excel Reports Using the Reports REST API
List Asynchronous Runs of a Report
Filter Reports on Demand
List Recently Viewed Reports
Decode the Fact Map
Get Report Data without Saving Changes to or Creating a Report
Save Changes to Reports
Clone Reports
Delete Reports
Examples: Dashboards REST API Resources
Examples: Analytics Notifications REST API
Reports API Resource Reference
Report Types API Resource Reference
Filter Operators API Resource Reference
Dashboards API Resource Reference
Analytics Notifications API Resource Reference
Analytics Folders API Resource Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Examples: Reports REST API Resources

The Reports and Dashboards REST API is designed to let you query report data easily.

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