Manage audience exports
If your instance of Sitecore CDP has a Scheduled or Live segment with at least one segment member, you can start exporting audiences for use outside Sitecore CDP.
Create an export
To create an audience export:
-
On the navigation menu, click Audience export > Audience export > Create export.
-
Determine whether to export full datasets or deltas. To export a full audience, click Full export. Alternatively, to export deltas, click Delta export.
-
Enter a unique and intuitive name for the export and click Create. The Build screen displays.
After creating an export, you must select an audience and choose an output format for it before you can run it.
Select an audience for an export
Every audience export must have an audience.
To select an audience for the export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
If you are working with a scheduled export, click Pause so you can access the Build screen.
-
On the Build screen, in the Audience section, click Add segment to select the segment for this export. Alternatively, if a segment is already specified, click Edit to select a different segment for this export.
-
Optionally for a full export, to export only a subgroup of the segment, click Filter.
-
Click the condition you want to use to filter the audience.
-
Complete the fields for the condition.
-
Click Save.
-
Choose the output format
Every audience export must have an output format.
To choose the output format for an audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
If you are working with a scheduled export, click Pause so you can access the Build screen.
-
On the Build screen, click Output format > Define output. Alternatively, if the output format is already specified, click Edit.
-
On the Define output screen, specify the following:
-
File format - choose whether to export the audience as a CSV or a JSON output.
You can further customize the CSV output by choosing whether to:
-
Output structure - choose what data to include in the output and in what structure.
-
Click Add column.
-
In the Header field, enter a unique text for the header.
-
In the Attribute value field of a string field, you can include the following data:
-
In the Attribute value field of a number field, you can include numeric versions of integers and floats. You can also specify:
-
-
-
Click Save.
Set up email notifications
You can get notified by email when the export finishes running. The email contains instructions for downloading the output.
To set up email notifications for the audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
If the export is not scheduled, on the Build screen, click Notifications.
If the export is scheduled, click the Notifications tab.
-
To get notified by email, click Notify me. To send additional email notifications to other addresses, click Add recipients. In the Add recipients field, enter an email address, then press Enter.
Add a connection to an export
As part of sending the exported data to third-party systems, you have to add an existing connection to your audience export. After that, you can receive the output of the export in the connected external service, extract it, and upload the data to systems such as social media platforms, digital advertising platforms, email marketing apps, and business intelligence (BI) tools.
To add a connection to an audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
If the export is not scheduled, on the Build screen, click Notifications > Add connection, then select the connection for this export.
If the export is scheduled, click the Notifications tab > Add connection, then select the connection for this export.
ImportantMake sure the connection request URL and headers do not contain variables, and that the request payload only contains the variables available in the standard audience export notification attributes.
Your audience export is now connected to an external service. The service will receive a webhook notification every time the audience export finishes running.
Test an export
We recommend that you test an export before running it to make sure that the output of the export will contain the data you included in the output following the output structure you configured.
To test an audience export:
-
Navigate to the Test window depending on where in the application you currently are:
-
If you are on the Define Output screen of an audience export, click Test.
-
If you are elsewhere in the application:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
On the audience export page, click Test.
NoteIf you are working with a scheduled export, click Pause so you can access the Test button.
-
-
-
In the Test window, click Test scenario.
-
Select a guest for the test:
-
To use a random guest for the test, click the search field, and then in Quick select, click Visitor or Customer.
-
To use a guest from the specific segment used in the audience export, on the Build screen, in the Audience section, click the segment name to open it. View the segment's usage and details, and from the Usage section, copy a guest reference. Then, paste the copied reference into the search field.
-
-
Click Test. The test runs for the guest.
-
Click Response. If the test is successful, the output of the export for this guest displays in Output.
If the test is unsuccessful, an error displays in Output. Additional JavaScript logs display in Logs. See common errors and how to fix them.
Run a full export instantly
After you select an audience for a full export and choose the output format, you can run the export.
To run a full audience export instantly:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
If you are working with a scheduled export, click Pause so you can access the Run now button.
-
Click Run now. The export starts running.
After the audience export finishes running, you can download the output on the same page in Activity > Finished exports, by clicking Download output.
If you have set up email notifications or added a connection to the export, a notification will be sent.
Schedule a full export
After you select an audience for a full export and choose the output format, you can run the export.
To run a full audience export on schedule at repeated intervals:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
Click Schedule.
-
On the Schedule audience export screen, specify the following settings:
-
The Start date - choose when the export will run for the first time.
-
The End date - choose when the export will run for the last time.
-
The Repeat interval - choose how often the export will run.
-
The Run time - choose at what time of day the export will run.
-
-
On the Summary pane, review the schedule details.
-
Click Schedule. The export will run based on the schedule settings.
After the audience export finishes running for the first time, you can download the output on the same page in Activity > Finished exports, by clicking Download output.
If you have set up email notifications or added a connection to the export, a notification will be sent.
Schedule a delta export
After you select an audience for a delta export and choose the output format, you can run the export by scheduling it to run once a day.
To schedule a delta audience export on a daily schedule:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
Click Schedule.
-
On the Schedule audience export screen, specify the following settings:
-
The Start date - choose when the export will run for the first time.
-
The End date - choose when the export will run for the last time.
-
The Run time - choose at what time of day the export will run.
-
-
On the Summary pane, review the schedule details.
-
Click Schedule. The export will run based on the schedule settings.
After the audience export finishes running for the first time, you can download the output on the same page in Activity > Finished exports, by clicking Download output.
If you have set up email notifications or added a connection to the export, a notification will be sent.
Enable and disable downloading the output
Team members with an Admin role in Sitecore Cloud Portal can enable and disable the ability to download the output of an audience export directly from Sitecore CDP. This applies to all users in the tenant.
To enable or disable downloading the output directly from Sitecore CDP:
-
On the navigation menu, click
> Manage features.
-
Next to Audience export files download, turn the switch
on to enable, or turn it off to disable downloading the output.
-
Click Save.
Download the output
Your Sitecore CDP administrator controls whether you can download the output.
After the audience export finishes running, one way you can access the exported data is by downloading the output directly from Sitecore CDP.
To download the output of an audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
Click Activity > Finished exports > Download output.
Pause an export
If you want to edit a scheduled export, for example, reschedule, test, delete, or change the output structure of a scheduled export, or run a scheduled full export instantly, you first have to pause it.
You can run a full export instantly even when it's paused.
To pause an audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
Click Pause > Pause. You can now access the Build screen and edit the export.
Resume an export
You can resume a paused export so it will run on schedule again.
You can run a full export instantly even when it's paused.
To resume a paused audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
Click Schedule, then schedule the export.
Copy an export
You can create a copy of an export, when, for example, you want a duplicate of an existing export with small differences.
To create a copy of an audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
Click ellipsis > Duplicate.
-
Enter a unique and intuitive name for the new export and click Create. The Build screen of the new export displays.
Delete an export
You can delete an export when you know for certain that no one in your organization needs to use the export.
To delete an audience export:
-
On the navigation menu, click Audience export > Audience export, then the export you want to work with.
-
If you are working with a scheduled export, click Pause so you can access the Delete button.
-
Click ellipsis > Delete > Delete.