| Table of Contents |
|---|
Introduction
The Export module allows accessing the data the loyalty program generates. Administrators can generate reports to get an overall view of their data of customers, coupons, or stores – among others – tailored to their actual requirements. The Export module enables them to define the content of the export using several kinds of fields and filters.
This chapter contains descriptions of the different export functions and instructions on how to create and configure exports on the Antavo loyalty platform.
| Table of Contents |
|---|
Export management
Navigate to Modules and type Exports to the search field. The page opens up to a list of existing reports generated by administrators.
...
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 for download.
Failed: The export process has failed. If the issue persists, please contact your Account Manager.
Creating
...
Follow these steps to create a new export Navigate to Modules and type Exports to the search field.
...
Click on the Create new export button.
...
a new export
To start creating a new export click the ‘Create new export’ button on the left sidebar.
Data model
First, select the data model to export:
Webhook logs
Content approval
Products
Coupons
Coupon pools
Stores
Customers
Events
Customer fields
Changes
Rewards
...
Click the Next button to continue with the configuration of the export.
...
Configuring an export
...
| Info |
|---|
Note: The Appendix chapters contain detailed information on the attributes |
...
of each exportable feature. |
Localization
Name
Set the name of the export. The name of the downloaded file will be inherited from the name you provide here.Timezone
The brand’s timezone and the user’s timezone are highlighted separately.
Filters
Filters
Different types of filters amend the reports and make the query results more efficient.
The following options are available:
...
NAME
...
TYPE
...
DESCRIPTION
...
Attribute
Attribute - Drop-down list
...
Select the property to include in the export.Operator
...
- Drop-down list
...
Select an action to include in the export.Value
...
- Free-text field or drop-down list
...
Define the value relating to the action to be performed
...
Aggregation
...
Checkbox.
...
in the export.
The system allows combining the
...
filters.
...
NAME
...
DESCRIPTION
...
AND
...
The following options are available:
and: adds a new set of criteria within the same filtering
...
...
OR
or: adds a new set of criteria in a separate filtering
...
Support for relative date fields
Exports can be run based on filters signifying relative dates (e.g., today, yesterday, last year, this quarter, next month etc.). Choose in date as the operator to find the related date filters.
...
Aggregation
Aggregation enables the export of data to be grouped by basic aggregation operators.
...
The aggregation will be applied to every field which
...
is mandatory to be filled.
This can be set when creating or cloning an export within the Filters section.
See Creating an Export.
See Cloning an Export.
See Filters.
...
Tick the checkbox to display a calculated or grouped value instead of separate values in the export.
Add the required fields to the export.Open the dropdown list at the bottom of each field to select the type of aggregation. This is a mandatory field to fill.
...
This can be set when creating or cloning an export within the Filters section.
...
.png?version=1&modificationDate=1652209554386&cacheVersion=1&api=v2)
Group
Use this option to define group ID values in the report.
Note: At least one field should be marked as group, but more than one field can be specified.Count
Use this option to retrieve the number of entries in a group in the report.
Note: This counts the number of entries, not the fields. If more than one field is marked as count, the same count value will be produced in the report.Sum
Use this option to retrieve the total amount of numerical values in the report.Average
Use this option to retrieve an approximation of numerical values in the report.Min
Use this option to retrieve the lowest field value for each group in the report.Max
Use this option to retrieve the highest field value for each group in the report.
Click Create after setting each required field to start the export process.
Field
...
settings
Use the + icon and select a field from the drop-down list to add new data to the export.
...
Each field will populate a separate column in the export file.
File
...
NAME
...
TYPE
...
DESCRIPTION
...
Delimiter
...
Drop-down list.
extensions
Choose between .csv and .psv extension.
File format options
Delimiter
Select the character that separates data in the export file.Enclosure
...
Drop-down list.
...
Select the character to group certain values into one data field.
Newline
...
Select an option to determine how to add a new line.No header
...
Checkbox.
Tick the checkbox to exclude the header row from the export file.
Scheduling
This option allows to run running the exports in a specified time and even also set them as recurrent.
By default, the files are exported at the time of the request, however, exporting can be scheduled by selecting the On-date or Repeated values in the dropdown list.
On-date
The export
...
will start on a predefined date and time.
Use the date and time selector to specify the scheduled time by clicking on the icons in the Date and Time fields.
It is also possible to enter the details manually.
...
Repeated
Select this option to set the data export to be triggered periodically.Daily
Set the time of the day when the export should start.
Weekly
Select the day(s) of the week
...
and set the time of the day.
Monthly
Select the day(s) of the month
...
and set the time of the day.
You can use the ‘Last’ value to make sure the export is started on the last day of
...
the month, regardless of the number of days in a given month.
...
Update Target
Select a file transfer option from the drop-down list to get the export file uploaded to a server directly.
...
Provide the details in the fields that appear after selecting an option.
...
Field list
At the bottom of the interface, you can find the list of exportable fields with the data type of the fields, their possible values, whether they are mandatory, and their description.
...
When the status of the export changes to Finished, the Download hyperlink appears under the summary of the export criteria.
Click on the hyperlink to download the compressed file. The system You will also sends receive an email including a link to the export exported file.
...
Cloning an export
Cloning allows repeating an existing export without having to create a new configuration from the beginning.
This feature is helpful for comparing the latest results with the data of a previous export to see the differences.
It is You can also possible to modify the settings by changing the filters and fields.
Navigate to Modules and type Exports to the search field.
The to the Exports module which opens up to the list of exports appears.
...
Click on Details of the export that you wish to clone.
...