The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

getDatasets

Retrieves a collection of CRM Analytics datasets.

getDatasets uses this CRM Analytics API resource.

  • createdAfter— (Optional) Filter the collection to include only datasets created after a specific timestamp.
  • createdBefore— (Optional) Filter the collection to include only datasets created before a specific timestamp.
  • datasetTypes— (Optional) Filters the collection to include only datasets of one or more of the specified types.
    • Default
    • Live
    • StagedData
    • Trended
  • folderId— (Optional) Filters 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.
  • hasCurrentOnly— (Optional) Filters the collection of datasets to include only those datasets that have a current version. The default is false.
  • ids— (Optional) Filter the collection to include only datasets with the specified IDs.
  • includeCurrentVersion— (Optional) Includes the current dataset version metadata in the collection. The default is false.
  • lastQueriedAfter— (Optional) Filter the collection to include only datasets last queired after a specific timestamp.
  • lastQueriedBefore— (Optional) Filter the collection to include only datasets last queried before a specific timestamp.
  • licenseType— (Optional) The response includes datasets with this license type. The default is EinsteinAnalytics.
    • Cdp (Data Cloud)
    • DataPipelinesQuery (Data Pipelines Query)
    • EinsteinAnalytics (CRM Analytics)
    • IntelligentApps (Intelligent Apps)
    • MulesoftDataPath (Mulesoft Data Path)
    • Sonic (Salesforce Data Pipelines)
  • order— (Optional) Ordering to apply to the collection results.
    • Ascending
    • Descending
  • page— (Optional) Generated token that indicates the view of datasets to be returned.
  • pageSize— (Optional) Number of items to be returned in a single page. Minimum is 1, maximum is 200, and the default is 25.
  • q— (Optional) 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 URL along with any other special characters.
  • scope— (Optional) Scope type to apply to the collection results.
    • CreatedByMe
    • Mru (Most Recently Used)
    • SharedWithMe
  • sort— (Optional) Sort order to apply to the collection results.
    • ConnectionName
    • CreatedBy
    • CreatedDate
    • LastModified
    • LastQueried
    • LastRefreshed
    • Mru (Most Recently Used, last viewed date)
    • Name
    • TotalRows
  • supportsNewDates— (Optional) Indicates whether to include only datasets that support new dates in the collection (true) or not (false). The default is false.
  • typeOfDataflow- (Optional) Filter the collection to include only datasets with the specified type of dataflow.