Automated exports

When a regular export is required, usually for processes such as exporting of user profiles to a third-party platform, then Xtremepush Automations is the place to go.

This feature allows users to set up hourly (only available for some export types), daily, weekly or monthly export schedules via SFTP or email.

Exports

Navigate to Data > Automations and select the Exports tab.

This menu shows the full list of exports for the project and specifically their Target, Frequency and Status. It is also possible to see when they last ran and whether that export was successful.

Clicking on the last run timestamp shows details and any errors for that export.

Actions that can be performed on an existing automation can be found under > more.Exports can be activated/de-activated and run now if an immediate export is required.

Create export

Click the Create Export button to be taken to the wizard-driven setup process.

Export Type

After giving the new export a name, the first step is to set up where you would like the export to go and the type of data you would like it to contain.

Target Settings.Set where the data should be sent at the time of export. There are several options available:

Export to an email. Type out an email address and press enter. Multiple addresses can be added so the export will be sent to multiple people. When the export is complete, a message will be sent to the list of emails provided containing a link to a secure page where the export can be downloaded.
Export to client SFTP. Select an SFTP account that has been set up beforehand via the project's Integrations Marketplace.
Export an audience to a retargeting platform. This option will only show up if you have integrated ad retargeting from the Integrations Marketplace. Review our dedicated Ad Retargeting page for more details.

Data Type.Select whether you want to export profile, device, or campaign engagement data.

Profiles generates a report where each line item contains the profile record along with any associated attribute data.
Devices exports a report where each row is a single device. Available fields:

Field	Description
`id`	Device ID (Xtremepush identifier)
`profile_id`	Profile ID (Xtremepush identifier)
`user_id`	User ID (if provided)
`subscription`	Push subscription status (`1`, `0`)
`last_subscription_change`	Timestamp in Unix format for when this status was last updated
`addressable`	Push addressable status (`1`, `0`)
`last_addressable_change`	Timestamp in Unix format for when this status was last updated

Consent Preferences generates a report that includes details about user consent preferences. This report type is only available if the Consent Management feature is enabled on the project. Available fields:

Field	Device ID (Xtremepush identifier)
`user_id`	User ID (if provided)
`name`	The name of the consent preference.
`type`	The type of consent preference (e.g., Marketing, Legitimate Interest).
`channel`	The communication channel associated with the preference (e.g., Email, SMS).
`update_time`	The last time the preference was updated, in `Y-m-d H:i` format.
`status`	The status of the preference (`1`, `0`)

Campaign engagement produces a report where each row is an engagement action in relation to a campaign. Available fields:

Field	Description
`campaign_id`	Campaign ID
`campaign_name`	Campaign name
`category_id`	Engagement category ID (if applicable)
`category_name`	Engagement category name (if applicable)
`user_id`	User ID (if available)
`profile_id`	Profile ID (XP identifier)
`device_id`	Device ID (XP identifier)
`message_type`	Message channel (email, journey, SMS, push, etc)
`message_variant`	Split test variant (if applicable)
`message_variant_name`	Split test variant name (if applicable)
`language_variant`	Language variant (if applicable)
`campaign_schedule_type`	Campaign schedule type (recurring, triggered, time)
`email`	Email address of the profile (if available)
`mobile_number`	Mobile number of the profile (if available)
`from_name`	From name (only applicable for email and SMS campaigns)
`subject_line`	Subject line (only applicable for email campaigns)
`title`	Push title (only applicable for iOS, Android and web push campaigns)
`interaction_type`	Interaction type (sent, delivered, open, click, close, failed, etc)
`interaction_value`	Additional info about the interaction (reason for failure, redirect URL of the click, bounce reason, etc)
`workflow_action_id`	Workflow node ID (only applicable for workflow campaigns)
`workflow_action_name`	Workflow node name (only applicable for workflow campaigns)
`timestamp`	Unix timestamp of the interaction (in UTC)
`interaction_id`	Message action ID (only applicable for workflow campaigns)
`trigger_id`	ID that identifies each batch of users entering a workflow. If users enter the same workflow campaign more than once, a different trigger ID will show up against them
`external_message_id`	ID passed by the client along with the original trigger
`labels`	A comma-separated list of labels stored against the campaign

Can't see this option?
Automating a campaign engagement report is a new feature. Contact us if you would like to use it.

Selecting the Delta Report option will make sure the export only contains records that have been created or changed since the last time it ran, rather than being an export of the entire data in the project. For campaign engagement reports, the delta report option is compulsory.

File size management
When you select Campaign Engagement as your data type, you can use Rows Limit to manage file sizes.
Use the Rows Limit field to specify the maximum number of rows per exported file. The maximum limit is 1,000,000 rows and the minimum is 100,000. It is recommended to specify a row limit if your project has a high volume of user activity.
If the total number of records exceeds your specified limit, additional files are created to accommodate the remaining data.

First export of Delta engagement report
The first run of the delta engagement report provides the records from the point when export is first set up on the project until the time of run. Subsequent exports will generate records created or changed since the last time the report ran.

Data Structure

Segment Settings
The export will only include data for user profiles or devices which match the given Segment.
Export AttributesSelect which attributes should be included with the list of user profiles in the export.You can rearrange the selected attributes to order them in the CSV file. This might be useful if the export is being picked up by an external platform which requires them in a specific order.

It is only possible to add attributes to the exported file for profile exports.

This step doesn't apply to campaign engagement exports.

Schedule

Finally, a frequency for export can be set on the scheduling step. After saving the schedule it will run at the next available time closest to the current time. Note the timezone set in your project and account for any adjustment needed in your process to avoid issues such as a file being updated in the SFTP by a system running in a timezone different to the one set in the automation schedule.

Documentation Index