Datasets List Resource

Returns a collection of Tableau CRM dataset and creates a new dataset.

Resource URL

1/wave/datasets

Formats

JSON

Available Version

GET 36.0 POST 50.0

Available Components

Aura — <wave:sdk> listDatasets()
LWC — lightning/analyticsWaveApi getDatasets()

HTTP Methods

GET POST

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`datasetTypes`	ConnectWaveDatasetTypeEnum	The type of the dataset. Valid values are: `Default` `Live` `StagedData` `Trended`	Optional	50.0
`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	Indicates whether to filter the list of datasets to include only those datasets that have a current version (`true`) or not (`false`).. The default is `false`.	Optional	52.0
`ids`	ID[]	Filter the list of datasets to include only datasets with the specified ids.	Optional	53.0
`includeCurrentVersion`	Boolean	Indicates whether to include the current dataset version metadata in the collection (`true`) or not (`false`).. The default is `false`.	Optional	52.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	Filters the collection by the Analytics license type.. Valid values are: `EinsteinAnalytics` (Tableau CRM) `Sonic` (Salesforce Data Pipeline)	Optional	52.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: `App` `CreatedBy` `CreatedDate` `LastModified` `LastModifiedBy` `Mru` (Most Recently Used, last viewed date) `Name` `Type`	Optional	38.0
`supportsNewDates`	Boolean	Indicates whether to filters the list of datasets to include only those datasets that support new dates (`true`) or not (`false`).. The default is `false`.	Optional	52.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.

Response body for GET

Dataset Collection

Request body for PATCH

Dataset Input

Response body for POST

Dataset

Tableau CRM REST API Developer Guide

Datasets List Resource