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.
note: Downloads are requested by entering the URI in a browser address bar.
Standard Example Usage
<domain>/analytics/download/dashboard/0FKB0000000xxxxxxx.pdf
| Parameter | Description |
|---|---|
assetType |
Required. Specifies what type of Analytics asset to download. Valid values are:<ul><li>dashboard</li><li>lens</li><li>lightning-dashboard</li><li>report</li></ul> |
assetId |
Required. Specifies the Analytics asset id to download. |
downloadType |
Required. Specifies what file type to download the Analytics asset as. Valid values are:<ul><li>png</li><li>pdf</li></ul> |
Query Parameter Example Usage
Download a specific page and saved view of a CRM Analytics dashboard.
<domain>/analytics/download/dashboard/0FKB0000000xxxxxxx.pdf?savedViewId=0Svxx&pageId=page1
Download a CRM Analytics dashboard to print on legal-sized paper.
<domain>/analytics/download/dashboard/0FKB0000000xxxxxxx.pdf?pageSize=LEGAL
Download a CRM Analytics dashboard without the tabular widget data.
<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:<ul><li>A3</li><li>A4</li><li>LEGAL</li><li>LETTER</li></ul> |
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.