Audience sync REST API (legacy)

Important

Audience export is replacing Audience sync. See Audience export REST API.

You can use the Audience sync REST API to retrieve batch jobs.

Attribute	Type	Description	Example(s)
`ref`	string	The unique reference of the batch job.	`"e866db03-1766-4895-9eba-8cfd4766b89d"`
`clientKey`	string	The client key retrieved from Sitecore CDP.	`"mhbWwbHYfhpheu86hp60oR76S4jQMmZr"`
`flowRef`	string	The Universal Unique Identifier (UUID) of the flow.	`"9d496538-6079-49ff-8911-9964f0333528"`
`segmentRef`	string	The UUID of the segment.	`"5225682b-55c2-404f-852a-e65cf6c05961"`
`datasetDate`	integer	The Sitecore CDP snapshot that the flow ran against.	`1475017200000`
`oozieWorkflowId`	string	The worflow ID. This is only used internally by Sitecore.	`"0000624-160826091123569-oozie-hado-W"`
`status`	string	The status of the batch job.	`"QUEUED", "PROCESSING", "SUCCESS", "FAILED", "PENDING", "CANCELLED"`
`s3GuestContextPath`	string	The s3 path for the guest context input dataset.	`"s3://sitecore-data-derived-dev-eu-west-1/guest-contexts/2016/09/28/pqsPERS3lw12v5a9rrHPW1c4hET73GxQ/"`
`s3FlowExecutionPath`	string	The s3 path for the flow execution output path.	`"s3://sitecore-batch-flows-dev-eu-west-1/2016/09/28/pqsPERS3lw12v5a9rrHPW1c4hET73GxQ/9d496538-6079-49ff-8911-9964f0333528/ec5b12fc-f70b-4bcc-950e-338bbf41c66e/"`
`startTime`	integer	This is the time the batch job executed.	`1475055599015`
`numberPartitions`	integer	The number of partitions. This is only used internally by Sitecore.	`64`
`createdAt`	integer	The date when the batch job was created.	`1475055607784`
`guestContextSize`	integer	The total number of guest profiles in your organization.	`5039845`
`segmentSize`	integer	The number of guests in the segment.	`34987`
`modifiedAt`	integer	The date when the batch job was modified.	`1475052110900`
`s3JobStatus`	JSON array of JSON objects	Contains additional attributes on the status of the batch job.	N/A
`code`	string	The status of the s3 job.	`"SUCCESS", "FAILED"`
`yarnApplicationID`	string	The yarn application ID. This is only used internally by Sitecore.	`"application_1470045793564_4838"`
`batchJobRunId`	string	The unique reference of the batch job.	`"ec5b12fc-f70b-4bcc-950e-338bbf41c66e"`
`processed`	integer	The total number of guests that were processed by the batch job.	`34987`
`fired`	integer	The total number of guests that matched guest conditions on the flow.	`34987`
`firedWithOffers`	integer	The number of guests that matched guest conditions on flows that received offers.	`25958`
`failed`	integer	The number of guests that failed to process.	`2`

Do you have some feedback for us?

If you have suggestions for improving this article,