Salesforce Reports and Dashboards REST API Developer Guide

Overview
Examples
Reports Examples
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
Dashboards Examples
Downloads Examples
Notifications Examples
Reference
PDF

Newer Version Available

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

Download Formatted Excel Reports Using the Reports REST API

You can use the Reports REST API to request reports in printer-friendly Excel format.

To execute a report and obtain the results, the Salesforce Lightning Report Builder issues a REST request to the Analytics API. The API is a POST to the endpoint /services/data/vXX.x/analytics/reports/<reportId>.

After the report is created, use a GET request to obtain the results. By default, results are returned in JSON format, which is rendered by the Report Run page. This format is specified in the Accept header information.

If you are using Workbench, click Headers in the API Explorer to view and modify the current Accept header. (For more on Workbench, see Using Workbench.)

Request Excel Output

This endpoint isn’t designed for concurrent export of large formatted reports. To avoid impacts on overall system load, don’t run more than one large report export at a time.

Note

To request Excel instead of JSON format, change the Accept value in the request header to application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

Now when you execute a GET request, the Excel file is created. The raw response includes the Excel filename, as shown in bold in the following example. You can add code to your application to download the file from the response stream.

1Raw Response
2HTTP/1.1 200 OK
3Date: Wed, 06 Jun 2018 17:23:58 GMT
4Strict-Transport-Security: max-age=31536000; includeSubDomains
5X-Content-Type-Options: nosniff
6X-XSS-Protection: 1; mode=block
7Content-Security-Policy: upgrade-insecure-requests 
8Cache-Control: no-cache,must-revalidate,max-age=0,no-store,private
9Set-Cookie: BrowserId=YJXhUq42SRyZ3hhgDPFxog;Path=/;Domain=.salesforce.com;Expires=Sun, 05-Aug-2018 17:23:58 GMT;Max-Age=5184000
10Expires: Thu, 01 Jan 1970 00:00:00 GMT
11Sforce-Limit-Info: api-usage=4/15000
12Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
13Content-Disposition: attachment; filename="New Opportunities Report-2018-05-06-10-23-59.xlsx"
14Transfer-Encoding: chunked