Sitecore API catalog/Audience export API/Any export job

Any export job

You can access output URLs for any finished export job by making two API requests. First retrieve a list of all finished export jobs of an audience export, then retrieve the output URLs for the finished export job of your choice.

Operations

Retrieve a list of all finished export jobs

Request

Retrieves a list of all finished export jobs of an audience export.

In the response, in every object in the array, the executionRef key contains the export job reference. You use the export job reference to retrieve the output URLs for that specific export job.

Security
BearerToken
Path
audienceExportRefstringrequired

The audience export reference. Set this value either to the friendly ID or the UUID reference of the audience export.

To find these values in Sitecore CDP, click Audience export > Audience export, then the export you want to work with. The friendly ID is on the Details pane. The UUID reference is a 36-character string in the web browser's address bar, starting after audience-export/.

Example friendly ID: daily_loyalty_members Example UUID reference: d6c5335a-4028-49c0-8d55-a534e89127c9

Example:daily_loyalty_members
curl -i -X GET \
  https://api-engage-ap.sitecorecloud.io/v2/audienceExports/definitions/daily_loyalty_members/reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful operation

Bodyapplication/json
Array [
clientKeystring

Your organization's unique and public identifier.

Example:"pqsPERS3lw12v5a9rrHPW1c4hET73GxQ"
executionRefstring, (uuid)

The export job reference.

Use this as the jobExecutionRef path parameter when you retrieve output URLs for a specific export job.

Example:"fe351e84-3504-4668-8e5f-574d320b9679"
definitionRefstring, (uuid)

The UUID reference of the audience export.

Example:"d6c5335a-4028-49c0-8d55-a534e89127c9"
friendlyIdstring

The unique ID of the audience export.

Only lowercase alphanumeric characters and underscores are allowed.

Example:"daily_loyalty_members"
executionTypestring

Whether the audience export runs instantly or on a schedule.

Enum:"INSTANT_RUN""SCHEDULED"
Example:"INSTANT_RUN"
statusstring

The status of the export job.

Enum:"PENDING_GUEST_CONTEXT""PENDING_SEGMENTATION""PENDING_EMR_SUBMIT""PENDING_EMR_JOB""SUCCESS""FAILED""ALERT"
Example:"SUCCESS"
definitionTypestring

Whether the audience export is a full or a delta export.

Enum:"DELTA""FULL_SYNC"
Example:"FULL_SYNC"
segmentExecutionTypestring

Whether the segment in the audience export is scheduled or live.

Enum:"ON_DEMAND""LIVE"
Example:"LIVE"
totalinteger, (int32)

The number of guests in the segment selected for the export.

Example:101308
filterMatchedGuestsinteger, (int32)

The number of guests matched by the filter. These guests are included in the export. If no filter was used, the value is 0.

Example:97466
filterNotMatchedGuestsinteger, (int32)

The number of guests not matched by the filter. These guests are excluded from the export. If no filter was used, the value is 0.

Example:3842
filterFailuresinteger, (int32)

The number of guests that filtering failed for. If no filter was used, the value is 0.

Example:16
successesinteger, (int32)

The number of guests the export succeeded for.

Example:97466
failuresinteger, (int32)

The number of guests the export failed for.

Example:0
programmableErrorsArray of objects(Errors)

A list of errors related to the JavaScript in the export and the attribute values in the output structure.

filterErrorsArray of objects(Errors)

A list of errors related to conditions, for example, errors with the JavaScript in a condition.

errorLogsArray of strings

A list of all errors.

Example:"[TypeError: Cannot read property 'length' of undefined]"
datasetDatestring

The date the export job started running.

Example:"2024/10/16"
startTimestring, (date-time)

The UTC time the export job started running.

Example:"2024-10-16T06:00:01.122Z"
endTimestring, (date-time)

The UTC time the export job finished running.

Example:"2024-10-16T06:40:45.794Z"
successAddinteger, (int32)

Guests added to the segment after the export job ran. This attribute is only present in delta exports.

Example:0
successRemoveinteger, (int32)

Guests removed from the segment after the export job ran. This attribute is only present in delta exports.

Example:0
]
Response
[
  {
    "clientKey": "pqsPERS3lw12v5a9rrHPW1c4hET73GxQ",
    "executionRef": "fe351e84-3504-4668-8e5f-574d320b9679",
    "definitionRef": "d6c5335a-4028-49c0-8d55-a534e89127c9",
    "friendlyId": "daily_loyalty_members",
    "executionType": "INSTANT_RUN",
    "status": "SUCCESS",
    "definitionType": "FULL_SYNC",
    "segmentExecutionType": "LIVE",
    "total": 101308,
    "filterMatchedGuests": 97466,
    "filterNotMatchedGuests": 3842,
    "filterFailures": 16,
    "successes": 97466,
    "failures": 0,
    "programmableErrors": [ … ],
    "filterErrors": [ … ],
    "errorLogs": "[TypeError: Cannot read property 'length' of undefined]",
    "datasetDate": "2024/10/16",
    "startTime": "2024-10-16T06:00:01.122Z",
    "endTime": "2024-10-16T06:40:45.794Z",
    "successAdd": 0,
    "successRemove": 0
  }
]