CRM Analytics REST API Developer Guide
jNewer Version Available
Collections List Resource
Returns a list of collections or creates a collection. Each collection contains Analytics resource items.
Resource URL
1/analytics/collections1/wave/collectionsFormats
JSON
Available Version
52.0
HTTP Methods
GET POST
Request parameters for GET
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| editableOnly | Boolean | Filters the results for only collections the current user has edit access to. | Optional | 52.0 |
| includeItems | Boolean | Indicates whether the collection items are returned in the response (true) or not (false). | Optional | 52.0 |
| label | String | Filters the results for collections list to match the specified label. | Optional | 54.0 |
| limit | Integer | The limit of collections to return. | Optional | 52.0 |
| offset | Integer | Indicates the starting index for list of collections returned. The default value is 0. | Optional | 52.0 |
| pageToken | String | The token to use for next page. | Optional | 52.0 |
| pinnedOnly | Boolean | Filters the results for pinned collections only. | Optional | 52.0 |
| type | CollectionTypeEnum | Filters the results by collection type. Valid values are: Static. The default is to return all types of collections. | Optional | 52.0 |
| visibleOnly | Boolean | Indicates whether only visible collection items are returned in the response (true) or not (false). | Optional | 57.0 |