CRM Analytics REST API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
Datasets List Resource
Dataset Resource
Dataset Versions List Resource
Dataset Version Resource
Dataset Version File Resource
Dependencies Resource
Eclair Chart Resources
Features Configuration Resource
Folder Resources
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

Datasets List Resource

Returns a collection of Analytics dataset and creates a dataset.

Resource URL

/wave/datasets

Formats

JSON

Available Version

GET 36.0 POST 50.0

Available in Postman

To view and test a working example of this resource, see getDatasetCollection 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

GET Request Parameters

Parameter Name Type Description Required or Optional Available Version
created​After String Filters the results to include only the contents created after a specific timestamp. Optional 56.0
created​Before String Filters the results to include only the contents created before a specific timestamp. Optional 56.0
dataset​Types Connect​Wave​Dataset​Type​Enum The type of the dataset. Valid values are:
  • Default
  • Live
  • Staged​Data
  • Trended
 Optional 50.0
folder​Id 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
has​Current​Only 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 52.0
ids ID[] Filter the list of datasets to include only datasets with the specified ids. Optional 53.0
include​Current​Version Boolean Indicates whether to include the current dataset version metadata in the collection (true) or not (false). The default is false. Optional 52.0
last​Queried​After String Filters the results to include only the contents last queried after a specific timestamp. Optional 56.0
last​Queried​Before String Filters the results to include only the contents last queried before a specific timestamp. Optional 56.0
license​Type Connect​Analytics​License​Type​Enum Filters the collection by the Analytics license type. Valid values are:
  • Cdp (Data Cloud)
  • Data​Pipeline​Query (Data Pipeline Query)
  • Einstein​Analytics (CRM Analytics)
  • Intelligent​Apps (Intelligent Apps)
  • Sonic (Salesforce Data Pipeline)
 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
page​Size 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 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​Dataset​Sort​Order​Type​Enum The type of sort order to be applied to the returned dataset collection. Valid values are:
  • Connection​Name (only valid if the dataset is a Live Dataset)
  • Created​By
  • Created​Date
  • Last​Modified
  • Last​Queried
  • Last​Refreshed
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Total​Rows
 Optional 38.0
supports​New​Dates Boolean Indicates whether to filter the list of datasets to include only those datasets that support new dates (true) or not (false). The default is false. Optional 52.0
type​Of​Dataflow String Filters the list of datasets to include only those datasets that have the specified type of dataflow. Optional 61.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: 
/wave/datasets?hasCurrentOnly=true&filterGroup=Supplemental
This request filters the list of datasets and adds the following supplemental fields to the output representation:
  • current​Version​Created​By
  • current​Version​Created​Date
  • current​Version​Last​Modified​By
  • current​Version​Last​Modified​Date
For more information about the filterGroup parameter, see Specifying Response Sizes in the Connect REST API Developer Guide.

Response body for GET

Dataset Collection

Request body for POST

Dataset Input

Response body for POST

Dataset