Datasets List Resource

Returns a list of Analytics datasets.

Resource URL

1/wave/datasets

Formats

JSON

Available Version

36.0

HTTP Methods

GET

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
`hasCurrentOnly`	Boolean	Filters the list of datasets to include only those datasets that have a current version. The default is `false`.	Optional	36.0
`order`	Enum	Ordering applied to the results. Valid values are: `Ascending` `Descending`	Optional	42.0
`page`	String	A generated token that indicates the view of datasets to be returned.	Optional	36.0
`pageSize`	Int	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: `CreatedByMe` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `LastModified` `LastModifiedBy` `Mru` (Most Recently Used) `Name`	Optional	38.0

You can filter the results to include only those datasets that have a current dataset version defined by using the hasCurrentOnly parameter. You can also request supplemental information about datasets that have a current dataset version defined by using the filterGroup parameter. For example, the following GET request sets these parameters:

1/wave/datasets?hasCurrentOnly=true&filterGroup=Supplemental

This request filters the list of datasets and adds the following supplemental fields to the output representation:

currentVersionCreatedBy
currentVersionCreatedDate
currentVersionLastModifiedBy
currentVersionLastModifiedDate

For more information about the filterGroup parameter, see Specifying Response Sizes in the Connect REST API Developer Guide.

GET Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`datasets`	DatasetRepresentation[]	The list of datasets available to the current user.	Small, 36.0	36.0
`nextPageUrl`	String	The URL to retrieve the next page of contents in the collection.	Small, 36.0	36.0
`totalSize`	Integer	The total count of the elements in the collection, including all pages.	Medium, 36.0	36.0
`url`	String	The URL to retrieve the collection.	Small, 36.0	36.0

Analytics REST API Developer Guide

Datasets List Resource