Salesforce Reports and Dashboards REST API Developer Guide

Overview
Examples
Reference
Analytics Download
Analytics Download
Analytics Notifications
Dashboards
Filter Operators
Folders
Reports
Report Types
PDF

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.

Analytics Download

Download a .png image of a CRM Analytics dashboard or lens, or Lightning Experience dashboard or report. Download a .pdf file of a CRM Analytics dashboard or lens. Request downloads via browser calls.

Syntax

URI: domain/analytics/download/assetType/assetId.downloadType

To request a download, enter the URI in a browser address bar.

We don't support the use of this API from Apex.

Note

Formats: .png or .pdf

Parameters

Parameter Description
assetType Required. Specifies what type of Analytics asset to download. Valid values are:
  • dashboard
  • lens
  • lightning-dashboard
  • report
assetId

Required. Specifies the Analytics asset id to download.
downloadType Required. Specifies what file type to download the Analytics asset as. Valid values are:
  • png
  • pdf

For Lightning Experience reports, the request works only with png and only if the report has a chart. If you use pdf or if the report doesn’t have a chart, the request returns an error.

Note

Query Parameters

Parameter Description
includeData Optional. Indicates whether to include that tabular widget data (true) or not(false).
pageId Optional. Specifies the Id for a dashboard page to download.
pageSize Optional. Specifies page size to download. Valid values are:
  • A3
  • A4
  • LEGAL
  • LETTER
savedviewId Optional. Specifies the Id for a dashboard saved view to download.

For Lightning Experience reports, the request works only with png and only if the report has a chart. If you use pdf or if the report doesn’t have a chart, the request returns an error.

Note

Response Body

The response body is binary data of the .png or .pdf representation of the Analytics asset.