Guides

Create Export

In this page you'll learn how to export data from your applications. From the list of export jobs, click in the New Job button top right corner:

To access this page expand the Data menu and click in Export:

Main Menu

In this page, click in the New Export button in the top right corner:

new export job button

This will open a page where you will actually create your export job. You should start by choosing which type job you want to create:

types

Read further to learn how to export all the types of data that we collect for your app.

Export Devices/Contacts/Numbers

To export the device data stored in your application, select the Export Devices from the Job Type selector:

job type devices

To export all the devices including the inactive ones, toggle the following option:

export all

By default we will export all the devices (with any medium), to export only devices with a certain medium use the following option:

medium

If you wish to include the device tags in the export job, toggle the following option:

include tags

When you toggle this option, you will be able to specify the tag separator. By default we will use the vertical bar (a.k.a pipe) as the separator but you can use this field to define another character:

tags separator

If you wish to limit the export of your devices, you can use the familiar Criteria selection to filter out the devices you need.

criteria

Learn how to setup a custom criteria by reading our guides located here.

Export Users

To export the user data stored in your application, select the Export Users from the Job Type selector:

job type users

If you would like to include users that are also inactive, toggle the following option:

export all users

If you would like to include the users' segments, toggle the following option:

include segments

If you toggle this option ON, there's two different ways of including segments, Combined will simply include all the segments of a user in one single column and Separated will include all segments in individual columns.

include segments options

If you choose Combined, you will only be able to select if you wish to export the segments' names instead of their Ids. For that toggle the following option:

show names

If you choose Separated you will also be able to select if you wish to export the segments' names instead of their Ids:

show names

Additionally, if you have the Users & Authentication add-on, you will also be able to include all the user preferences by toggling the following option:

include user preferences

Optionally, if you just want to export certain segments, you can select them in the following field:

filter segments

For that, you will need to search for existing segments like shown below:

search segments

You can select one more segments by clicking in the one you want to use:

select segments

When you are done selecting segments, simply click the Done button. The selected segments will look like this:

selected segments

If you wish to limit the export of your users, you can use the familiar Criteria selection to filter out the devices you need. You also have the option of filtering out users by last active date and/or registration date

user criteria

Learn how to setup a custom criteria by reading our guides located here.

Export User Data

To export a specific user's data stored in your application, select the Export User Data from the Job Type selector:

job type user data

Then go ahead and search for a user in your application by using the field below:

search user

And finally click in the user you wish to export data of. It will look like the field below:

selected user

This job will generate a .zip file with all the data from this user, including notifications, devices, location data and replies and all its media files (if any).

Export Regions

To export all the regions you've created so far, you only have to select the Export Regions option from the Job Type selector:

job type regions

Export Beacons

To export the all the beacons you've created so far, you only need to select the Export Beacons options from the Job Type selector:

job type beacons

Export Messages

To export all the messages you've created so far, select the Export Messages from the Job Type selector:

job type messages

Optionally, for this export job, you can provide a date range of the messages you want to export:

date range

If you would like to use relative dates instead, you can toggle the following option ON:

use relative dates

When this option is ON, you are able to instead the values for your start and end date in seconds:

relative dates

This allows you to provide a period of time relative to the date when the job is executed. This can be extremely useful when you are using Scheduled Tasks.

If you also want to include archived messages too, make sure you toggle the following option:

include all messages

Optionally you will also be able to select if you wish to export the segments' names instead of their Ids (if applicable):

show names

Export Replies

To export replies generated by your push campaigns, select the Export Replies from the Job Type selector:

job type replies

Then you should select which push message you want to export replies in the following field:

search notifications

When you're done selecting a message, it should look like this:

selected notification

Export Events

To export events generated by you applications, select the Export Events from the Job Type selector:

job type events

And make sure you select which type of events you want to export. Learn more about event types here.

event type

If you have selected the Custom Event type, you also need to provide the name of your custom event:

custom event name

Optionally, for this export job, you can provide a start and end date for the events you want to export:

date range

If you would like to use relative dates instead, you can toggle the following option ON:

use relative dates

When this option is ON, you are able to instead the values for your start and end date in seconds:

relative dates

This allows you to provide a period of time relative to the date when the job is executed. This can be extremely useful when you are using Scheduled Tasks.

Additionally, for this type of export job, you can provide an advanced filtering criteria. This is similar to what you can do when sending a notification. It will allow you to filter the results of this export job based on segments, tags, location or device properties:

event criteria

Learn more about how to setup a criteria in our guides located here.

Finally if you've selected an event of type Custom Event and you are looking to export only events with certain values (your app must register arbitrary data for this to work) you can use Custom Data Filters to get a fine-grained export job based on the data you care about:

data filters

Learn more about how to create data filters in our guides located here.

Export Passes

To export all the passes generated by a specific pass template, select the Export Passes from the Job Type selector:

job type passes

And select the pass template which you would like to export passes from. To do that you need to search for an existing pass template in the following field:

search pass templates

Then simply click the desired template to select it:

selected pass template

Export Campaign Results

To export the results of a campaign, select the Export Campaign Results from the Job Type selector:

job type campaign results

And select the campaign which you would like to export the results from. To do that you need to search for an existing campaign in the following field:

search campaign results

Then simply click the desired campaign to select it:

selected campaign results

Export Campaigns Summary

To export the stats summary of one or more campaigns, select the Export Campaigns Summary from the Job Type selector:

job type campaigns summary

And select one or more campaigns you would like to export the summary from. To do that you need to search for an existing campaign:

search campaigns summary

To select campaigns, simply click in the campaign you wish to add:

select campaigns summary

When you are done selecting campaigns, click in the Done button and this field will look like the one below:

selected campaigns summary

Export Automation Connectors Summary

To export the stats summary of one or more automation connectors, select the Export Automation Connectors Summary from the Job Type selector:

Job Type

And select one or more automation connectors you would like to export the summary from. To do that you need to search for an existing connector:

Search Connector

Then simply click to select one or more connectors from the resulting list as shown below:

select connectors

One you've selected the connectors you wish to export the summary from, click in the Done button. It will display something like the field shown below:

selected connectors

Once you are done selecting all the options for your export job, click in the Create Job button to actually create it:

create button

Learn how to download your export job files, by reading the guides located here.