Datasets List Resource

Returns a list of Analytics datasets.

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 Chatter REST API Developer Guide.

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. 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. 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	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. Wild cards aren’t supported.	Optional	36.0
`scope`	Enum	Type of scope to be applied to a collection resource representation. `CreatedByMe` `IncludeAllPrivate`: Include other users’ private folders `SharedWithMe`		41.0
`sort`	Enum	Property names that can be sorted. Values are: `CreatedBy` `CreatedDate` `LastModified` `LastQueried` `LastRefreshed` `Mru`: Most recently used (last viewed date) `Name` `TotalRows` The default value is `Mru`.	Optional	42.0

GET Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`datasets`	Dataset Resource[]	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

Example Response Body

1{
2  "datasets" : [ "/* Datasets detail omitted for brevity. */" ],
3  "nextPageUrl" : "/services/data/v36.0/wave/datasets?page=eyJwYWdlU2l6ZSI6MjUsInNv",
4  "totalSize" : 33,
5  "url" : "/services/data/v36.0/wave/datasets"
6}

Analytics REST API Developer Guide

Datasets List Resource