Datasets List Resource | Tableau CRM REST API Developer Guide

1/wave/datasets

JSON

GET 36.0 POST 50.0

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

GET POST

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	36.0
`ids`	ID[]	Filters the list of datasets to include only those 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	The Tableau CRM license types. Valid values are: `EinsteinAnalytics` `Sonic`	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`	ConnectWaveDatasetSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `CreatedBy` `CreatedDate` `LastModified` `LastQueried` `LastRefreshed` `Mru` (Most Recently Used, last viewed date) `Name` `TotalRows`	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.

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

Property Name	Type	Description	Required or Optional	Available Version
`currentVersionId`	ID	DEPRECATED The 18-character ID of the current version of this dataset.	Optional	36.0–40.0
`datasetType`	ConnectWaveDatasetTypeEnum	The type of the dataset. Valid values are: `Default` `Live` `StagedData` `Trended`	Required	50.0
`folder`	ID	The 18-character ID of the folder that contains the dataset.	Optional	36.0
`liveConnection`	LiveConnectionInputRepresentation	The live connection details for the dataset.	Optional	50.0
`userXmd`	XmdInputRepresentation	The user XMD associated with this dataset.	Optional	39.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Optional	51.0

Property Name	Type	Description	Filter Group and Version	Available Version
`clientShardsUrl`	String	The URL for the dataset shards.	Small, 36.0	36.0
`currentVersionCreatedBy`	WaveUserRepresentation	The creator of the current version of the dataset. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionCreatedDate`	Date	The time at which the current version of the dataset was created, in ISO8601 date format. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionId`	ID	The 18-character ID of the current dataset version.	Small, 36.0	36.0
`currentVersionLastModifiedBy`	WaveUserRepresentation	The user who last updated the current version of the dataset. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionLastModifiedDate`	Date	The last time the current version of the dataset was modified, in ISO8601 date format. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionSupportsNewDates`	Boolean	Indicates whether the current dataset version supports new date formats (`true`) or not (`false`).	Supplemental, 52.0	52.0
`currentVersionTotalRows`	Integer	The total number of rows in the dataset.	Supplemental, 42.0	42.0-52.0
`currentVersionTotalRowCount`	Integer	The total number of rows in the dataset.	Small, 53.0	53.0
`currentVersionUrl`	String	The URL for the current dataset version.	Small, 36.0	36.0
`dataRefreshDate`	Date	The last time this dataset was updated.	Small, 40.0	40.0
`datasetType`	ConnectWaveDatasetTypeEnum	The type of the dataset. Valid values are: `Default` `Live` `StagedData` `Trended`	Small, 41.0	41.0
`folder`	AssetReferenceRepresentation	The reference to the folder in which this dataset is stored.	Small, 36.0	36.0
`lastMetadataChangedDate`	Date	The last time the metadata (folder, label, current, sharing, or security predicate) of this dataset was changed.	Small, 51.0	51.0
`lastQueriedDate`	Date	The last time this dataset was queried.	Small, 39.0	39.0
`licenseAttributes`	LicenseAttributesRepresentation	The Analytics license attributes associated with this dataset.	Small, 52.0	52.0
`liveConnection`	LiveConnectionRepresentation	The live connection details for the dataset.	Small, 50.0	50.0
`userXmd`	XmdRepresentation	The associated user XMD.	Medium, 36.0	36.0
`versionsUrl`	String	The URL for dataset versions.	Small, 36.0	36.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Small, 51.0	51.0