getDataflowJobs

Retrieves a collection of CRM Analytics dataflow jobs.

getDataflowJobs uses this CRM Analytics API resource.

These parameters are optional.

Parameter NameTypeDescription
dataflowIdStringFilters the collection to only contain dataflow jobs tied to this specific dataflow. The ID must start with '02K'.
jobTypesString[]Filters the collection to only contain dataflow jobs with a specific job type. Possible values include:
  • DataCloudRecipe
  • DataSync
  • FileUpload
  • Internal
  • Orchestrated
  • Recipe
  • Recipe_V3
  • Report
  • Restore
  • User
licenseTypeStringThe response includes CRM Analytics assets 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)
Default is EinsteinAnalytics.
pageStringGenerated token that indicates the view of dataflow jobs 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.
startedAfterStringFilters the collection to only contain dataflow jobs started after the specified date and time (in Epoch seconds in UTC).
startedBeforeStringFilters the collection to only contain dataflow jobs started before the specified date and time (in Epoch seconds in UTC).
statusStringFilters the collection to only contain dataflow jobs with a specific runtime status. Possible values include:
  • Cancelled
  • Failure
  • Preprocessing
  • Queued
  • Running
  • Success
  • Warning

If a page or pageSize parameter isn’t provided, the response includes only the dataflow jobs run in the last 7 days. To see jobs older than 7 days, provide a page or pageSize parameter.