Salesforce Reports and Dashboards REST API Developer Guide
jNote: 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.
Download a CRM Analytics Dashboard as a PDF
Use a request on the Analytics Download resource to download a CRM Analytics dashboard as a .pdf binary file.
Standard Example Usage
1<domain>/analytics/download/dashboard/0FKB0000000xxxxxxx.pdf| Parameter | Description |
|---|---|
| assetType | Required. Specifies what type of Analytics asset to download. Valid values are:
|
| assetId |
Required. Specifies the Analytics asset id to download. |
| downloadType | Required. Specifies what file type to download the Analytics asset as. Valid values are:
|
Query Parameter Example Usage
Download a specific page and saved view of a CRM Analytics dashboard.
1<domain>/analytics/download/dashboard/0FKB0000000xxxxxxx.pdf?savedViewId=0Svxx&pageId=page1Download a CRM Analytics dashboard to print on legal-sized paper.
1<domain>/analytics/download/dashboard/0FKB0000000xxxxxxx.pdf?pageSize=LEGALDownload a CRM Analytics dashboard without the tabular widget data.
1<domain>/analytics/download/dashboard/0FKB0000000xxxxxxx.pdf?includeData=false| 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:
|
| savedviewId | Optional. Specifies the Id for a dashboard saved view to download. |
Example Response Body
The response body is binary data of the .pdf representation of the CRM Analytics dashboard.