1. Home
  2. Modules
  3. Extensions
  4. Exports

Exports

Introduction

Our Export module was built to help you access the data that your loyalty program generates. With our export tool, you can manually export 3 types of data structure (customers, events, and coupons) from Antavo’s database at any time. On the export setup page, you can use filters and add fields to define the content of the export. This will result in a downloadable .csv file inside a zipped folder.
You can find the Exports module’s configuration page by clicking on the ‘Modules’ item in the sidebar, and scrolling down to the ‘Extensions’ module category. The page will open to the list exports that have already been created with the following information:

  • Created at
    The date when the export was created.
  • Created by
    The platform user who created the export
  • Model
    The data structure that the export contains (customers, events or coupons).
  • Status
    • Pending: The setup of the export is saved, but the export process has not started yet.
    • Processing: The export process is in progress. 
    • Finished: The export process has finished and the export is ready to be downloaded.
    • Failed: The export process has failed. If the issue persists, please contact your Account Manager
  • Filesize
    The size of the export zip file in bytes.

Create a new export

  • Click on the ‘Create’ button on the right-hand side of the module configuration page
  • Choose the type of data structure that you’d like the export to contain.
    • Customers
    • Events
    • Coupons
  • Click the ‘Next’ button

Creating a customer export 

  • Add filter(s)
    Select filters from the dropdown menu to include specific segment(s) of customers in the export only. To combine more filters, use the ‘AND’ and ‘OR’  buttons
    Here’s the list of factory attributes and operators that you can use:
AttributeOperators
Numberspendableequals with

not equals with

is less than

is less than or equal to

is greater than

is greater than or equal to

 is between

age 
score
spent
purchase_total
purchase_count
purchase_avg_items
purchase_avg_total
Text_idequals with

not equals with

is less than

is less than or equal to

is greater than

is greater than or equal to

is between

contains

not contains

exists

not exists

starts with

not starts with

ends with

not ends with

regular expression

is in

is not in

first_name
last_name
status
email
gender
birth_date
last_login_at
language
currency
optin_at
location.city
location.state
location.country
birthday
Relations in segment

activity earned

reward claimed

action taken

item purchased

You can find how to add custom attributes below.

  • Add field(s)
    Use the checkboxes to add customer field data to your export. Each field will populate a column in the .csv export file.
    Here are the factory  fields that you can add:

      • Identifier (customer ID)
      • First name
      • Last name
      • Status
      • Email
      • Spendable (number of points currently available to spend)
      • Gender
      • Birth date
      • Last login at (date of last login)
      • Language
      • Currency
      • Age
      • Earned points
      • Opt-in at (date of enrollment)
      • Spent points
      • Total amount of purchase
      • Number of purchases
      • City
      • State
      • Country
      • Average number of purchased items
      • Average basket size
      • Birthday

You can find how to add custom fields below.

Examples

  • Exporting customers who have more than 3000 spendable points, including the customer ID, name, email address, and the number of spendable points they have

  • Exporting customers who enrolled in the program in the last month, including the customer ID, name, email address, age, and gender

  • Exporting active customers who logged into the program in the last 30 days, including their customer ID, name, and the date of the enrollment

  • Exporting customers who have redeemed a reward and still has points that can be spent, including their customer ID, email address, and the number of spendable points they have


You can initiate a customer export on the Customers and Segments pages of the Customer Insights menu.

Creating an event export 

  • Add filter(s)
    Select filters from the dropdown menu to include specific group(s) of events in the export only. To combine more filters, use the ‘AND’ and ‘OR’  buttons.
    Here’s the list of factory attributes and operators that you can use:
AttributeOperators
Numberpointsequals with

not equals with

is less than

is less than or equal to

is greater than

is greater than or equal to

 is between

date
Textcustomerequals with

not equals with

is less than

is less than or equal to

is greater than

is greater than or equal to

is between

contains

not contains

exists

not exists

starts with

not starts with

ends with

not ends with

regular expression

is in

is not in

expdate
source
action  equals with

 not equals with

user_idequals with

not equals with

exists

not exists

You can find how to add custom attributes below.

  • Fields
    Use the checkboxes to add event property data to your export. Each field will populate a column in the .csv export file.
    Here are the factory fields that you can add:
      • Customer (customer ID)
      • Date
      • Action (name of the event)
      • Points
      • Expiration date
      • Source
      • Administrator

You can find how to add custom fields below.

Examples

  • Exporting all reward claim events of the last week, including the customer ID and the number of points spent to claim each reward
  • Exporting all the events that customers earned points with, in the last 30 days, including the customer ID, the number of points rewarded, and the source of the event
  • Exporting all campaign bonus events that were added as a result of a rule in the Rule Editor, including the number of points earned and the date of the event

Creating a coupon export 

  • Add filter(s)
    Select filters from the dropdown menu to include specific group(s) of coupons in the export only. To combine more filters, use the ‘AND’ and ‘OR’  buttons.
    Here’s the list of factory attributes and operators that you can use:
AttributeOperators
Numbervalueequals with

not equals with

is less than

is less than or equal to

is greater than

is greater than or equal to

 is between

Textparent
friend referral or the ID of the reward or rule the assigns the coupon
equals with

not equals with

is less than

is less than or equal to

is greater than

is greater than or equal to

is between

contains

not contains

exists

not exists

starts with

not starts with

ends with

not ends with

regular expression

is in

is not in

code
customer
currency
amount
expires_in
expiration_date
referrer
pool
coupon_purchase_threshold
claimed_at
redeemed_at 
Type equals with

 not equals with

 

  • Fields
    Use the checkboxes to add event property data to your export. Each field will populate a column in the .csv export file.
    Here are the factory  fields that you can add:

      • Parent
      • Code
      • Customer (customer ID)
      • Currency
      • Amount
      • Value
      • Type
      • Expires in
      • Expiration date
      • Referrer
      • Pool
      • Coupon purchase threshold
      • Claimed at (date when the coupon was assigned to a customer)
      • Redeemed at (date when the coupon was used by the customer)

Examples

  • Exporting all coupons that have already been redeemed by customers,including the customer ID, the parent, and the date of redemption
  • Exporting coupons that has been assigned to a specific customer, including the customer ID and the coupon code
  • Exporting USD coupons that has been assigned to any customer, including the coupon code and its value

If you have applied all the filters and added all the data that you’d like to see in the coupon export, click the ‘Create’ button on the bottom of the page.

Download exports

After you click the ‘Create’ button on the Create export page, the Export page opens where you can  track the status of your export. As soon as the status of your export changes to ‘Finished’, the export is ready to be downloaded with the ‘Download’ button that appears, or, by following the link in the ‘Successful export’ email that we send.

Clone exports

You can reuse the settings of your former exports that you have already created by clicking the ‘Clone’ button on the Export page. The button will direct you to the export setup page with the settings of the previous export. By keeping the settings, you can repeat the same export to see how the data set has changed since the original export was created, or, you can choose to change the filters and fields.

Customizing your exports with custom fields

Besides the factory fields and filters listed above, you can use custom attributes in customer and event exports. Each custom field that has been defined in the customer object, or, tracked in an event, can be used as a filter or added as a data field in the export.

Using a custom customer field

The entire list of customer fields can be found if you open the Settings menu and navigate to the Customers tab. To use a custom field (which is not a built-in field) in your export, copy and paste the Unique ID as a filter or a field (eg. last_purchase_date).

Using a custom event field

You can find all the event fields by switching to the Events tab of any customer’s profile page and clicking the ‘Add action’ button or by opening the API Browser through the API tab of the Settings menu. Select an action from the dropdown list to discover its fields.

Follow these steps to convert the displayed name of custom fields into the format that can be used in exports:

  1. Take the displayed name of the field (eg. “Transaction Id”)
  2. Convert it into lowercase ( eg. “transaction id”)
  3. Replace spaces (if any) with “_” ( eg. “transaction_id”)
  4. Prefix with “properties.” (eg. “properties.transaction_id”)