Folders List Resource

Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.

Resource URL

1/wave/folders

Formats

JSON

Available Version

36.0

Available Components

Aura — <wave:sdk> listFolders()
LWC — lightning/analyticsWaveApi getWaveFolders()

HTTP Methods

GET POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`isPinned`	Boolean	Indicates whether to filter the collection of folders to return only pinned folders (`true`) or not (`false`).	Optional	36.0
`mobileOnlyFeaturedAssets`	Boolean	Indicates whether to filter the collection of folders to show only dashboards that are enabled for the Analytics mobile app (`true`) or not (`false`).	Optional	43.0
`page`	String	A generated token that indicates the view of folders to be returned.	Optional	36.0
`pageSize`	Integer	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: `Browse` `CreatedByMe` `InsightsApplicationsIsCansEdit` `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` `CreatedById` `CreatedDate` `FolderName` `LastModified` `LastModifiedBy` `LastModifiedById` `LastModifiedDate` `Location` `Mru` (Most Recently Used, last viewed date) `Name` `Outcome` `Owner` `RefreshDate` (for assets like datasets) `RunDate` (for assets like reports) `Status` `Title` `Type`	Optional	38.0
`templateFilters`	ConnectWaveTemplateSearchFiltersEnum	The filter templates to apply to the returned collection. Valid values are: `AppsConstructedByTemplate` `AppsWithInstallHistory`	Optional	57.0
`templateSourceId`	String	Filters the results to include only a collection of folders created from a specific template source	Optional	36.0