getDatasets

Retrieves a collection of CRM Analytics datasets.

getDatasets uses this CRM Analytics API resource.

These parameters are optional.

Parameter NameTypeDescription
createdAfterStringFilter the collection to include only datasets created after a specific timestamp.
createdBeforeStringFilter the collection to include only datasets created before a specific timestamp.
datasetTypesString[]Filters the collection to include only datasets of one or more of the specified types:
  • Default
  • Live
  • StagedData
  • Trended
folderIdStringFilters the collection to only contain datasets for the specified folder. The ID can be the requesting user's ID for datasets in the user's private folder.
hasCurrentOnlyBooleanFilters the collection of datasets to include only those datasets that have a current version. The default is false.
idsString[]Filter the collection to include only datasets with the specified IDs.
includeCurrentVersionBooleanIncludes the current dataset version metadata in the collection. The default is false.
lastQueriedAfterStringFilter the collection to include only datasets last queried after a specific timestamp.
lastQueriedBeforeStringFilter the collection to include only datasets last queried before a specific timestamp.
licenseTypeStringThe response includes datasets with this license type. Possible values include:
  • Cdp (Data Cloud)
  • DataPipelinesQuery (Data Pipelines Query)
  • EinsteinAnalytics (CRM Analytics)
  • IntelligentApps (Intelligent Apps)
  • MulesoftDataPath (Mulesoft Data Path)
  • Sonic (Salesforce Data Pipelines)
The default is EinsteinAnalytics.
orderStringOrdering to apply to the collection results:
  • Ascending
  • Descending
pageStringGenerated token that indicates the view of datasets to be returned.
pageSizeIntegerNumber of items to be returned in a single page. Minimum is 1, maximum is 200, and the default is 25.
qStringSearch terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. Special characters are automatically removed.
scopeStringScope type to apply to the collection results:
  • CreatedByMe
  • Mru (Most Recently Used)
  • SharedWithMe
sortStringSort order to apply to the collection results:
  • ConnectionName
  • CreatedBy
  • CreatedDate
  • LastModified
  • LastQueried
  • LastRefreshed
  • Mru (Most Recently Used, last viewed date)
  • Name
  • TotalRows
supportsNewDatesBooleanIndicates whether to include only datasets that support new dates in the collection (true) or not (false). The default is false.
typeOfDataflowStringFilter the collection to include only datasets with the specified type of dataflow.