CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Quick Start
Examples
Resources
CRM Analytics REST API Resources Overview
Wave Resource
Actions Resource
Analytics Assets Resources
Annotation Resources
Asset Files Resources
Auto-Install Request Resources
Collection Resources
Dashboard Resources
Data Connector Resources
Dataflow Job Resources
Dataflow Resources
Dataset Resources
Dependencies Resource
Eclair Chart Resources
Features Configuration Resource
Folder Resources
Folders List Resource
Folder Resource
Folder Schedule Resource
Folder Settings Resource
JsonXform Transformation Resource
Limits Resource
Lens Resources
Query Resource
Recipe Resources
Replicated Dataset Resources
Schedule Resource
Subscription Resources
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Template Resources
Trended Report Resources
Watchlist Resources
Xmd Resources
Requests
Responses
Appendices
PDF

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 in Postman

To view and test a working example of this resource, see getWaveFolderCollection in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quick Start.

Available Components

HTTP Methods

GET POST

Request parameters for GET

Parameter Name Type Description Required or Optional Available Version
is​Pinned Boolean Indicates whether to filter the collection of folders to return only pinned folders (true) or not (false). Optional 36.0
mobile​Only​Featured​Assets 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 Connect​Wave​Scope​Type​Enum The type of scope to be applied to the returned collection. Valid values are:
  • Browse
  • Created​By​Me
  • Insights​Applications​Is​Cans​Edit
  • Mru (Most Recently Used)
  • Shared​With​Me
 Optional 38.0
sort Connect​Wave​Sort​Order​Type​Enum The type of sort order to be applied to the returned collection. Valid values are:
  • App
  • Created​By
  • Created​By​Id
  • Created​Date
  • Folder​Name
  • Last​Modified
  • Last​Modified​By
  • Last​Modified​By​Id
  • Last​Modified​Date
  • Location
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Outcome
  • Owner
  • Refresh​Date (for assets like datasets)
  • Run​Date (for assets like reports)
  • Status
  • Title
  • Type
 Optional 38.0
template​Filters Connect​Wave​Template​Search​Filters​Enum The filter templates to apply to the returned collection. Valid values are:
  • Apps​Constructed​By​Template
  • Apps​With​Install​History
 Optional 57.0
template​Source​Id String Filters the results to include only a collection of folders created from a specific template source Optional 36.0

Response body for GET

Wave Folder Collection

Request body for POST

This is a Wave Folder Input or a Wave Folder Template Input, both of which implement the Base Wave Folder Input.

Response body for POST

Wave Folder