Audience export REST API

The Audience export REST API lets you access the output of an audience export job.

After an audience export job finishes running, its output becomes available at presigned URLs. You can download the output of the export job by opening the URLs.

To access output URLs using the Audience export REST API, you can:

Retrieve the output URLs for the most recently finished export job.
Retrieve a list of all finished export jobs for the export, then retrieve the output URLs for the export job of your choice.

The following table describes audience export attributes:

Attribute	Type	Description	Example(s)
`executionRef`	string (UUID)	The reference of the audience export job.	`"fe351e84-3504-4668-8e5f-574d320b9679"`
`definitionRef`	string (UUID)	The UUID reference of the audience export.	`"d6c5335a-4028-49c0-8d55-a534e89127c9"`
`friendlyId`	string	The unique ID of the audience export. Only lowercase alphanumeric characters and underscores are allowed.	`"daily_loyalty_members"`
`executionType`	string enum (uppercase)	Whether the audience export runs instantly or on a schedule.	Must be one of: `"INSTANT_RUN"` `"SCHEDULED"`
`definitionType`	string enum (uppercase)	Whether the audience export is a full or a delta export.	Must be one of: `"DELTA"` `"FULL_SYNC"`
`status`	string enum (uppercase)	The status of the audience export job.	Must be one of: `"FAILED"` `"SUCCESS"`
`segmentExecutionType`	string enum (uppercase)	Whether the segment in the audience export is scheduled or live.	Must be one of: `"LIVE"` `"SCHEDULED"`
`total`	integer	The number of guests in the segment selected for the export.	`101308`
`filterMatchedGuests`	integer	The number of guests matched by the filter. These guests are included in the export.	`97466`
`filterNotMatchedGuests`	integer	The number of guests not matched by the filter. These guests are excluded from the export.	`3842`
`successes`	integer	The number of guests the export succeeded for.	`97466`
`failures`	integer	The number of guests the export failed for.	`0`
`filterFailures`	integer	The number of guests that filtering failed for.	`16`
`filterErrors`	array of objects	A list of errors related to conditions, for example, errors with the JavaScript in a condition.	RequestResponse `[ { "description": "TypeError: Cannot read property 'length' of undefined", "count": 16 } ]`
`programmableErrors`	array of objects	A list of errors related to the JavaScript in the export and the attribute values in the output structure.	RequestResponse `[ { "description": "ReferenceError: age is not defined", "count": 32 } ]`
`errorLogs`	array of strings	A list of all errors.	RequestResponse `[ "ReferenceError: age is not defined", "ReferenceError: age is not defined", "TypeError: Cannot read property 'length' of undefined" ]`
`startTime`	string	The time the export job started running.	`"2024-10-16T06:00:01.122Z"`
`endTime`	string	The time the export job finished running.	`"2024-10-16T06:40:45.794Z"`
`expireAt`	string	The time the output URLs expire.	`"2024-11-05T12:08:00.145Z"`
`numberOfFiles`	integer	The total number of files included in the output.	`2`
`totalSizeKB`	integer	The total size of all the output files in kilobytes.	`54`
`exports`	array of objects	A list of all the presigned output URLs for the export job.	RequestResponse `[ { "url": "https://sitecore-cdp-...", "sizeKB": 52 } ]`

The exports array of objects:

Attribute	Type	Description	Example(s)
`url`	string	The presigned output URL for the export job.	`"https://sitecore-cdp-..."`
`sizeKB`	integer	The size of the output file in kilobytes.	`52`
`deltaAction`	string enum	Whether the presigned output URL of a delta export contains the added guests or the removed guests. This attribute is only present in delta exports.	Must be one of: `"add"` `"remove"`

Attribute

Type

Description

Example(s)

url

string

The presigned output URL for the export job.

"https://sitecore-cdp-..."

sizeKB

integer

The size of the output file in kilobytes.

52

deltaAction

string enum

Whether the presigned output URL of a delta export contains the added guests or the removed guests.

This attribute is only present in delta exports.

Must be one of:

"add"
"remove"

Do you have some feedback for us?

If you have suggestions for improving this article,