CRM Analytics REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Dashboards List Resource
Resource URL
/wave/dashboardsFormats
JSON
Available Version
36.0
Available in Postman
To view and test a working example of this resource, see getDashboardCollection in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quick Start.
Available Components
- Aura — <wave:sdk> listDashboards()
HTTP Methods
GET POST
GET Request Parameters
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| folderId | ID | Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder. | Optional | 36.0 |
| ids | String | Filters the results to include only the dashboards with the specified ids. | Optional | 52.0 |
| mobileOnly | Boolean | Filters the results for mobile enabled dashboards only. | Optional | 41.0 |
| page | String | A generated token that indicates the view of dashboard to be returned. | Optional | 36.0 |
| pageSize | Integer | The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. | Optional | 36.0 |
| q | String | Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. | Optional | 36.0 |
| scope | ConnectWaveScopeTypeEnum | The type of scope to be applied to the returned collection. Valid values are:
|
Optional | 38.0 |
| sort | ConnectWaveSortOrderTypeEnum | The type of sort order to be applied to the returned collection. Valid values are:
|
Optional | 38.0 |
| templateApiName | String | Filters the results to include only a collection of dashboards created from a specific application template | Optional | 38.0 |
| type | ConnectWaveAssetTypeEnum | The asset type. The default type is Dashboard.
Valid types are:
|
Optional, Small, 36.0 | 36.0 |