Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

The Exports module allows accessing the data that is stored in Antavo’s database. Backoffice administrators can generate reports to get an overall view of the data of customers, coupons, or stores – among others – tailored to their current needs. When creating the export file, the module configuration interface provides options to add data fields and apply filters.

...

Expand
titleAggregation is not available if you have used any of the following filter operators listed below.
  • in_group (provided by the User groups module)

  • not_in_group (provided by the User groups module)

  • reward_claimed (provided by the Rewards module)

  • reward_not_claimed (provided by the Rewards module)

  • in_date

  • in_segment

  • not_in_segment

  • activity_earned

  • activity_not_earned

  • action_taken

  • action_not_taken

  • item_purchased

  • item_not_purchased

  • anniversary

  • age_range

...

  • From
    The ‘From’ value is automatically populated from the ID of the field selected and cannot be modified.

  • To
    The name of the field in the column header of the export file.
    If no ‘To’ value is added, the export will add the field to the header with the same name as it is in Antavo.

  • Default
    This value will be added to data cells where the field value of the individual entity is empty.

  • Replace values
    You can decide to overwrite certain data values that are stored in the database with a new value in the export file (eg. replace all ‘female’ values in the Gender customer field with ‘ladies' or replace ‘14’ values in the Age customer field with ‘underage’).
    Use the ‘Value to replace’ and ‘New value’ fields to define which value should be replaced and the target value added to the export.
    To map more than one value, click the ‘Add new field’ button.

  • Aggregation
    This mandatory setting is available if the ‘Aggregation’ option has been enabled in the previous step.
    Please note that computed fields cannot be aggregated. If you’re unsure if the field is a computed field, check the editor interface of the field (Events, Customers) or consult the Antavo Service Desk.
    Use the dropdown field to select one of the available aggregation methods:

    • Group
      At least one field has to be marked as ‘group’, which defines the field that will serve as the base of aggregation. Please note the ‘group’ option cannot be selected for identifier fields (eg. customer ID).

    • Count
      Use this option to retrieve the number of individual entries in the report. This method counts the number of entries, not the fields.
      Please make sure you add only one field with ‘count’ aggregation option.

    • Sum
      Use this option to retrieve the accumulated number of all numeric values of the data fields.
      Please note that this aggregation type is not applicable to non-numeric fields.

    • Average
      Use this option to retrieve the average value calculated from all the values of the items in the report.
      Please note that this aggregation type is not applicable to non-numeric fields.

    • Min
      Use this option to retrieve the lowest value of all the attribute values in the report.
      The Min value of string-type fields is calculated based on alphabetical order. If there’s an empty field, it is always considered the Min aggregated value.

    • Max
      Use this option to retrieve the highest value of all the attributes value in the report.
      The Max value of string-type fields is calculated based on alphabetical order.

...

You can select between .csv and .psv file extensions.

For challenge exports, only the .json file format is available.

...