Analytics REST API Developer Guide
jNewer Version Available
Folders List Resource
Creates an Analytics application (POST), which is
a folder that contains Analytics
datasets, lenses, and dashboards, or returns a
collection of applications or folders (GET).
- Resource URL
-
1/wave/folders - Formats
- JSON
- Available Version
- 36.0
- HTTP Methods
- GET and POST
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version isPinned Bool 36.0 mobileOnlyFeaturedAssets Bool Set this parameter to true 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 the folders 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 or SharedWithMe) 41.0 sort String Sort order of the results. Values are: - LastModified
- Mru: Most recently used (last viewed date)
- Name
The default is Mru.
Optional 36.0 templateSourceId String 36.0 - GET Response Body
-
WaveFolderCollectionRepresentation
Property Name Type Description Filter Group and Version Available Version folders Wave Folder[] 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
-
WaveFolderInputRepresentation
Property Name Type Description Required or Optional Available Version applicationStatus ConnectWaveApplicationStatusEnum The creation status of application (CancelledStatus, CompletedStatus, DataflowInProgressStatus, FailedStatus, InProgressStatus, NewStatus). 36.0 assetIcon String The icon enumeration that best represents the new folder or application. Valid values are 1.png through 20.png. 36.0 attachedFiles AssetReferenceInputRepresentation[] The attached file ID list 39.0 canBeSharedExternally Boolean Whether the application is shared in Communities 37.0 defaultAsset AssetReferenceInputRepresentation The ID of a lens/dashboard which is presented by default for this application in App Runtime. 37.0 description String The description of the new folder or application. 36.0 featuredAssets Map (FeaturedAssetsInputRepresentation) The featured assets for this application to be used in the UI. 39.0 isPinned Boolean Whether the application is a pinned folder. 39.0 label String The user-facing name of the new folder or application. 36.0 name String The internal API name of the new folder or application. 36.0 shares WaveFolderShareInputRepresentation[] The folder sharing rules. 36.0 - POST Response Body
-
Property Name Type Description Filter Group and Version Available Version applicationStatus ConnectWaveApplicationStatusEnum The creation status of application (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 Whether this app can be shared with Community Users. Big, 37.0 37.0 defaultAsset AssetReferenceRepresentation The default asset (lens/dashboard) that is presented when the app is viewed in AppRuntime mode. Big, 37.0 37.0 featuredAssets Map (FeaturedAssetsRepresentation) The 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 Whether this app is pinned/unpinned. 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 (Object) The template values used to create or update the folder or application (where applicable). Big, 37.0 37.0 templateVersion String The version of the template this application was created from. Medium, 37.0 37.0 assetSharingUrl String The URL for opening this asset in the Analytics builder. This is a form of deep linking. The server examines the link parameters, which might include urlType, assetId, orgId, and loginHost, as well as other optional parameters, and translates as necessary to produce the correct result on the target client. For example, it will open the Analytics dashboard on desktop clients, or mobile if you are on a mobile OS. For example, the shared URL: Might produce the following web Url:1http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comOr it might produce the following Url on iOS:1http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK1com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comSmall, 36.0 36.0 createdBy WaveUserRepresentation The asset creator. Small, 36.0 36.0 createdDate Date Time the asset was created. Small, 36.0 36.0 description String Short description of the asset. Small, 36.0 36.0 id String The 18 character asset ID. Small, 36.0 36.0 label String The label of the asset. Small, 36.0 36.0 lastAccessedDate Date Last time the asset was accessed. Small, 36.0 36.0 lastModifiedBy WaveUserRepresentation The user that last updated the asset. Small, 36.0 36.0 lastModifiedDate Date Last time the asset was modified. Small, 36.0 36.0 name String The name of the asset. Small, 36.0 36.0 namespace String The namespace of the asset. Small, 36.0 36.0 permissions PermissionsRepresentation Represents permissions for the present user. Small, 36.0 36.0 type ConnectWaveAssetTypeEnum The asset type. Values are: - Dashboard
- DataConnector
- Dataflow
- Dataset
- DatasetShard (internal)
- DatasetVersion
- ExternalData
- Folder
- Lens
- Recipe
- ReplicatedDataset
- Workflow
Small, 36.0 36.0 url String URL to get the definition of the asset. Small, 36.0 36.0