Salesforce Reports and Dashboards REST API Developer Guide

Salesforce Reports and Dashboards REST API
Requirements and Limitations
Examples: Reports REST API Resources
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

Requirements and Limitations

The Reports and Dashboards REST API is available for any organization that has API enabled. You must establish an authenticated session using OAuth in order to access the Reports and Dashboards REST API. When working with this API, consider these restrictions in addition to general API limits.

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

Responses and requests are in JSON. While using the Reports and Dashboards REST API with a POST request body, you must use content-type: application/json. You might get unexpected results if you don’t use this content type.

Note

Reports Limits
  • Cross filters, standard report filters, and filtering by row limit are unavailable when filtering data.
  • Historical trend reports are only supported for matrix reports.
  • The API can process only reports that contain up to 100 fields selected as columns.
  • A list of up to 200 recently viewed reports can be returned.
  • Your org can request up to 500 synchronous report runs per hour.
  • The API supports up to 20 synchronous report run requests at a time.
  • A list of up to 2,000 instances of a report that was run asynchronously can be returned.
  • The API supports up to 200 requests at a time to get results of asynchronous report runs.
  • Your organization can request up to 1,200 asynchronous requests per hour.
  • Asynchronous report run results are available within a 24-hour rolling period.
  • The API returns up to the first 2,000 report rows. You can narrow results using filters.
  • You can add up to 20 custom field filters when you run a report.
Dashboards Limits
  • Your org can request up to 200 dashboard refreshes per hour.
  • Your org can request results for up to 5,000 dashboards per hour.
Analytics Notification Limits
  • Each user can subscribe to up to 5 reports.
  • Each user can create up to 5 Wave notifications.

All limits that apply to reports created in the report builder also apply to the API, as do limits for dashboards created in the dashboard builder. For more information, see “Salesforce Reports and Dashboards Limits” in the Salesforce online help.

Note