Analytics REST API Developer Guide
jNewer Version Available
Folders List Resource
Returns a collection of applications or folders and creates an Analytics application, which is a
folder that contains Analytics
datasets, lenses, and dashboards.
- Resource URL
-
- Formats
- JSON
- Available Version
- 36.0
- HTTP Methods
- GET POST
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version isPinned Boolean Filters the collection of folders to return only folders where pinned is true. Optional 36.0 mobileOnlyFeaturedAssets Boolean Filters the collection of folders to show only dashboards that are enabled for the Einstein Analytics mobile app. 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: - 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 templateSourceId String Filters the results to include only a collection of folders created from a specific template source Optional 36.0 - GET Response Body
-
Property Name Type Description Filter Group and Version Available Version folders WaveFolderRepresentation[] A list of folders or applications. Small, 36.0 36.0 nextPageUrl String The URL for the next page of content in the collection. Small, 36.0 36.0 totalSize Integer The total count of the elements in the collection. Medium, 36.0 36.0 url String The URL for the collection. Small, 36.0 36.0 - POST Request Body (BaseWaveFolderInputRepresentation)
-
Property Name Type Description Required or Optional Available Version assetIcon String The icon enumeration that best represents the new folder or application. Valid values are 1.png through 20.png. Optional 36.0 description String The description of the folder or application. Optional 36.0 label String The user-facing name of the folder or application. Optional 36.0 name String The internal API name of the new folder or application. Optional 36.0 - POST Response Body (WaveFolderRepresentation)
-
Property Name Type Description Filter Group and Version Available Version appLog AppLogRepresentation The application log from the creation or upgrade of the application. Supplemental, 49.0 49.0 applicationStatus ConnectWaveApplicationStatusEnum The creation status of application. Valid values are: - CancelledStatus
- CompletedStatus
- DataflowInProgressStatus
- FailedStatus
- InProgressStatus
- NewStatus
Medium, 36.0 36.0 attachedFiles AssetReferenceRepresentation[] The id's of the files attached to the insights folder Big, 39.0 39.0 canBeSharedExternally Boolean Indicates whether this app can be shared with community users or not. Big, 37.0 37.0 defaultAsset AssetReferenceRepresentation The default dashboard or lens that is presented when the app is viewed in App Runtime mode. Big, 37.0 37.0 featuredAssets Map<String, FeaturedAssetsRepresentation> The map of featured assets for this application to be used in the UI. Big, 39.0 39.0 icon AssetReferenceRepresentation The asset icon. Small, 36.0 36.0 isPinned Boolean Indicates whether this app is pinned or not. Small, 39.0 39.0 shares WaveFolderShareRepresentation[] The folder shares list. Big, 36.0 36.0 templateOptions TemplateOptionsRepresentation The options used on the last action performed on a templated Analytics application. Big, 37.0 37.0 templateSourceId String The source template ID or api name used to create the folder or application. Medium, 36.0 36.0 templateValues Map<String, Object> The map of template values used to create or update the folder or application. Large, 37.0 37.0 templateVersion String The version of the template this application was created from. Medium, 37.0 37.0