Retrieve output URLs for a specific export job

Request

Retrieves the presigned URLs where you can download the outputs of the export job of your choice.

In the response, in every object in the exports array, the url key contains the output URL.

The URLs expire after a limited time. In the response, the expireAt key contains the expiration time. If you don't download the output before the URLs expire, you have to repeat this request to renew the URLs.

Security

BearerToken

Path

jobExecutionRefstringrequired

The export job reference.

If you don't know the export job reference, first retrieve a list of all finished export jobs. In the response, the executionRef key contains the export job reference.

Example:fe351e84-3504-4668-8e5f-574d320b9679

curl -i -X GET \
  https://api-engage-ap.sitecorecloud.io/v2/audienceExports/executions/fe351e84-3504-4668-8e5f-574d320b9679/export \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful operation

Bodyapplication/json

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"

clientKeystring

Your organization's unique and public identifier.

Example:"pqsPERS3lw12v5a9rrHPW1c4hET73GxQ"

expireAtstring, (date-time)

The UTC date and time the output URLs expire.

Example:"2024-11-05T12:08:00.145Z"

numberOfFilesinteger, (int32)

The total number of files included in the output.

Example:2

totalSizeKBinteger, (int64)

The total size of all the output files in kilobytes.

Example:54

exportsArray of objects(exports)

A list of all the presigned output URLs for the export job.

Response

{
  "executionRef": "fe351e84-3504-4668-8e5f-574d320b9679",
  "definitionRef": "d6c5335a-4028-49c0-8d55-a534e89127c9",
  "friendlyId": "daily_loyalty_members",
  "clientKey": "pqsPERS3lw12v5a9rrHPW1c4hET73GxQ",
  "expireAt": "2024-11-05T12:08:00.145Z",
  "numberOfFiles": 2,
  "totalSizeKB": 54,
  "exports": [
    { … }
  ]
}