Skip to main content

Use the retrieve batch flows job record function in Sitecore CDP REST API

Abstract

Provides details on retrieving batch flows job record in Sitecore CDP (Data model 2.1).

You can use the Audience Sync REST API to perform the retrieve batch flows job record function to retrieve a batch job for a flow. To do this, you must have the ref attribute included in the response when locating batch flow jobs.

To retrieve a batch flows job record in Sitecore CDP, use the following:

GET: https://apiEndpoint/v2/batchFlowsJob/<ref>

Attribute

Description

Type

ref

The Universal Unique Identifier (UUID) of the resource.

string

expand

Retrieves batch job status details.

boolean

$ curl -H 'Content-Type: application/json' -X GET 
https://{apiEndpoint}/v2/batchFlowsJob?flowRef=9d496538-6079-49ff-8911-9964f0333528&expand=true

The following is the 200 response for retrieving a batch flows job record:

{
  "href": "https://{apiEndpoint}/v2/batchFlowsJob/ec5b12fc-f70b-4bcc-950e-338bbf41c66e",
  "ref": "ec5b12fc-f70b-4bcc-950e-338bbf41c66e",
  "clientKey": "pqsPERS3lw12v5a9rrHPW1c4hET73GxQ",
  "flowRef": "9d496538-6079-49ff-8911-9964f0333528",
  "segmentRef": "5225682b-55c2-404f-852a-e65cf6c05961",
  "datasetDate": 1475017200000,
  "oozieWorkflowId": "0000624-160826091123569-oozie-hado-W",
  "status": "SUCCESS",
  "s3GuestContextPath": "s3://boxever-data-derived-dev-eu-west-1/guest-contexts/2016/09/28/pqsPERS3lw12v5a9rrHPW1c4hET73GxQ/",
  "s3FlowExecutionPath": "s3://boxever-batch-flows-dev-eu-west-1/2016/09/28/pqsPERS3lw12v5a9rrHPW1c4hET73GxQ/9d496538-6079-49ff-8911-9964f0333528/ec5b12fc-f70b-4bcc-950e-338bbf41c66e/",
  "startTime": 1475055599015,
  "numberPartitions": 64,
  "guestContextSize": 213414,
  "segmentSize": 15000000,
  "createdAt": 1475055607784,
  "modifiedAt": 1475052110900,
  "s3JobStatus": {
    "code": "SUCCESS",
    "yarnApplicationId": "application_1470045793564_4838",
    "batchJobRunId": "ec5b12fc-f70b-4bcc-950e-338bbf41c66e",
    "processed": 1000000,
    "fired": 1000000,
    "firedWithOffers": 850000,
    "failed": 20
  }
}