Data export
You can use dedicated API endpoints to export your data or download CSV files straight from the dashboard.
Contents
- Exports Overview
- Publications
- Redemptions
- Vouchers
- Customers and Segments
- Metadata
- Referral Program Exports
- Loyalty Campaign Exports
- Orders Exports
- Points Expirations Exports
- Transactions exports
- API exports
Exports overview
You can export vouchers, redemptions, publications, customers, and orders data. Whether you choose to use API or the dashboard, it is a two-step process:
1. Prepare an export file with filters and decide which attributes you want include.
2. Download your file once it's ready. In the dashboard, you have two options.
Notification Center | Audit Log > Exports |
In the dashboard, you can use the export tool to schedule the data export and then download a CSV file from the notification center. | You can also navigate to the Audit Log Manager and choose the Exports tab. There, you will see a list of your historical exports. By clicking on an export ID, you will be able to view the settings such as filters and parameters that were chosen for the export and have the option to download a copy of the export. You can also view the Activities for a particular export and get more insights by clicking on the event or log for the activity. |
Besides standard exports, Voucherify enables you to download:
- List of loyalty program members.
- List of referrers.
Publications
Publication assigns a unique code to a particular customer. You can download publications in the campaign dashboard. The CSV file includes a list of all publications.
Discount Vouchers and Gift Vouchers
Go to the campaign dashboard > Publications history. Click on the export tool.
Choose which publication details you want download, and confirm with Export.
Available attributes:
- Voucher Code
- Customer ID
- Publication Date
- Channel
- Campaign
- Customer Source ID
- Custom attributes (metadata)
Loyalty Program
Go to the campaign dashboard > Participants, and click on the export tool.
Choose which publication details you want download, and confirm with Export.
Available attributes:
- Voucher Code
- Customer ID
- Publication Date
- Channel
- Campaign
- Customer Source ID
- Custom attributes (metadata)
Redemptions
You can download all redemptions made in your account or use additional filters to select export data.
To download all redemptions, go to the Redemptions tab and click on the export tool.
You can decide which redemption details will be included in your CSV file. Besides standard attributes, you can download metadata assigned to redemptions.
Expand the defined fields to get an overview of included attributes.
Available attributes:
- Id
- Object
- Date
- Voucher code
- Campaign
- Promotion Tier
- Customer ID
- Customer Source ID
- Order ID
- Order Source ID
- Customer Name
- Tracking ID
- Order Amount
- Gift Amount
- Loyalty Points
- Result
- Failure Code
- Failure Message
- Custom attributes (metadata)
If you want download only specific redemption records, you can use the following customization:
I. Campaign – code redemptions
Redemptions coming from a particular campaign/standalone code can be downloaded directly from the campaign/code dashboard. Go to the Redemptions history and click Export.
II. Advanced filters
You can use advanced filters to browse particular redemptions and download them in a CSV file. Go to the Redemptions tab and choose Find and apply filters.
The filters let you browse redemptions using their status (successful, failed), creation date, redeeming User (team member), related voucher, and custom metadata attributes. When it comes to failed redemptions, you can group them using particular failure reasons.
You can apply many filters in a single query to list required redemptions.
Once you filter redemptions and confirm with Export, Voucherify starts preparing your file. You will be notified in the dashboard and via email once the CSV file is ready. Go to the dashboard > Notifications, and click Download next to the notification to save the file on your device.
Vouchers
You can download all vouchers created in your account or use additional filters to select export data.
To download all vouchers, go to the Vouchers tab and click on the export tool.
You can decide which voucher attributes will be included in your CSV file. Besides standard attributes, you can download metadata assigned to vouchers.
Expand the defined fields to get an overview of included attributes.
Available attributes:
- ID
- Code
- Voucher Type
- Value
- Formula
- Validation Rules ID
- Campaign
- Campaign ID
- Category
- Creation Date
- Last Update Date
- Start Date
- Expiration Date
- Gift Balance
- Loyalty Card Balance
- Redemption Limit
- Redemption Count
- Active
- QR Code
- Barcode
- Is referral code?
- Validity Timeframe Interval
- Validity Timeframe Duration
- Validity Day of Week
- Additional Info
- Customer ID
- Customer Source ID
- Discount Type
- Discount Unit Type
- Discount Effect
- Discount Unit Effect
- Discount Amount Limit
- Discount Aggregated Amount Limit
- Custom attributes (metadata)
Advanced filters
If you want to download only specific vouchers from a particular campaign or sharing the same metadata attributes, you can use filters and list vouchers that meet predefined criteria. Go to the Vouchers tab and choose Find and apply filters.
The filters display vouchers using their standard and custom metadata attributes. You can apply many filters in a single query. When all filters are set, confirm with Apply to view results.
Once you filter vouchers, click on the export tool and decide which voucher attributes will be included in your CSV file.
When you confirm with Export, Voucherify starts preparing your file. You will be notified in the dashboard and via email once the CSV file is ready. Go to the dashboard > Notifications, and click Download next to the notification to save the file on your device.
Customers and Segments
You can download the entire list of customers saved in your account or use additional filters to select export data.
To download all customers, go to the Customers tab, click Export in the upper right corner, and select the All customers button.
You can decide which attributes will be included in your CSV file. Besides standard attributes, you can download metadata assigned to customers.
Available attributes:
- Id
- Source ID
- Created At
- Description
- Address City
- Address State
- Address Line 1
- Address Line 2
- Address Country
- Address Postal Code
- Updated At
- Phone
- Birthdate
- Redemptions Total Redeemed
- Redemptions Total Failed
- Redemptions Total Succeeded
- Redemptions Total Rolled Back
- Redemptions Rollback Failed
- Redemptions Rollback Succeeded
- Orders Total Amount
- Orders Total Count
- Orders Average Amount
- Orders Last Order Amount
- Order Last Order Date
- Loyalty Points
- Loyalty Referred Customers
- Custom attributes (metadata)
Expand the defined fields to get an overview of included attributes. When ready, click Export to confirm.
Advanced filters
If you want to export data of a particular customer group, use filters and list customers that meet defined criteria. Go to the Customers tab and choose Add filter.
Filters group customers using their activity, standard (profile) data, and custom metadata. You can apply many filters and use conjunctions AND (customers must meet all filter) or OR (customers must meet at least one filter) to modify the results. The customer list will be updated in real time as each filter is applied.
Once you filter customers, click Export, select the Filtered list, and choose the attributes that will be included in your CSV file.
When you confirm with Export, Voucherify starts preparing your file. Once the CSV file is ready, you will be notified in the dashboard and via email. Go to the dashboard > Notifications, and click Download next to the notification to save the file on your device.
Segments
You can also export customers who belong to a segment. Go to Segments tab in the Engagement section. Click a segment to open a detailed view. Click Export segment to choose the attributes that will be included in your CSV file.
Confirm with Export. When your file is ready, you will receive a notification.
Available attributes:
- Name
- Id
- Source ID
- Created At
- Description
- Address City
- Address State
- Address Line 1
- Address Line 2
- Address Country
- Address Postal Code
- Updated At
- Phone
- Birthdate
- Redemptions Total Redeemed
- Redemptions Total Failed
- Redemptions Total Succeeded
- Redemptions Total Rolled Back
- Redemptions Rollback Failed
- Redemptions Rollback Succeeded
- Orders Total Amount
- Orders Total Count
- Orders Average Amount
- Orders Last Order Amount
- Order Last Order Date
- Loyalty Points
- Loyalty Referred Customers
- Custom attributes (metadata)
Metadata
You can export custom attributes added as metadata to customers, redemptions, vouchers, publications, and orders. Voucherify lets you choose which metadata attributes should be included in the file or download all metadata assigned to a particular object type (like customers metadata, redemptions metadata, and so on).
When choosing the export fields, you can see all metadata defined in the metadata schema.
When you choose a single metadata attribute, it will be included in your CSV file headers. For example, for metadata attribute channels, the CSV file column will be named metadata.channels.
If you choose to download all metadata properties, then each metadata defined in the schema and assigned to the exported object will be a separate column header, named after the metadata attribute (for example, for channel attribute, there will be a channel CSV column).
Referral Program Exports
In the referral program dashboard, you can download referral codes redemptions and the list of referrers (referral codes publications). Likewise, for each export, you can define what attributes, redemption data, or referrers you want include in your file.
Click on the referral program name and go to:
- Redemptions history tab to export all redemptions of referral codes
Available attributes:
- Id
- Object
- Date
- Voucher code
- Campaign
- Promotion Tier
- Customer ID
- Customer Source ID
- Order ID
- Order Source ID
- Customer Name
- Tracking ID
- Order Amount
- Gift Amount
- Loyalty Points
- Result
- Failure Code
- Failure Message
- Custom attributes (metadata)
- Referrers tab to download data of referral codes publications, including owners (referrers) details.
Available attributes:
- Voucher Code
- Customer ID
- Publication Date
- Channel
- Campaign
- Customer Source ID
- Custom attributes (metadata)
If you want export only referrers that have successful referrals, you need to go to the Customers tab in your dashboard and use filters.
- Choose Activity.
- Filter by Referred customers.
- Choose a referral campaign from the list.
- Define the condition (number of referrals).
Loyalty Program Exports
In the loyalty program dashboard, you can download a list of loyalty cards publications. Moreover, with filters in the Customers tab, you can group customers using points balance and export filtering results. Likewise, for each export, you can define what attributes and data of loyalty cards or customers you want include in your file.
Click on the loyalty program name and go to the Participants tab to export all loyalty cards and their owners.
Available attributes:
- Voucher Code
- Customer ID
- Publication Date
- Channel
- Campaign
- Customer Source ID
- Custom attributes (metadata)
If you want export participants with a particular score, you need to go to the Customers tab in your dashboard and use filters.
- Choose Activity.
- Filter by Loyalty points.
- Choose a loyalty program from the list.
- Define the condition (number of points on the customers' cards).
Order Exports
You can download all orders created in your account or use additional filters to select export data.
To download all orders, go to the Orders tab and click on the export tool.
You can decide which order attributes will be included in your CSV file. Besides standard attributes, you can download metadata assigned to orders.
Expand the defined fields to get an overview of included attributes.
Available attributes:
- Id
- Source ID
- Status
- Creation Date
- Last Update Date
- Amount
- Discount amount
- Items discount amount
- Total discount amount
- Total amount
- Customer ID
- Referrer ID
- Custom attributes (metadata)
When ready, click Export to confirm.
Advanced Filters
If you want download only specific orders sharing the same attributes, you can use filters and list orders that meet predefined criteria. Go to the Orders tab and choose Find and apply filters.
Filters browse orders using their standard and custom metadata attributes. You can apply many filters in a single query. When all filters are set, confirm with Apply to view results.
Once you filter orders, click on the export tool and decide which order attributes will be included in your CSV file.
When you confirm with Export, Voucherify starts preparing your file. You will be notified in the dashboard and via email once the CSV file is ready. Go to the dashboard > Notifications, and click Download next to the notification to save the file on your device.
Loyalty Point Expiration Exports
You can download all point expirations or use additional filters to select export data.
To download all points expirations, go to the Campaigns tab, choose a loyalty campaign, navigate to the Points Expiration tab.
Click on the export tool.
You can decide which order attributes will be included in your CSV file.
Expand the defined fields to get an overview of included attributes.
Available attributes:
- Id
- Campaign ID
- Voucher ID
- Status
- Expires on
- Points
When ready, click Export to confirm.
When you confirm with Export, Voucherify starts preparing your file. You will be notified in the dashboard and via email once the CSV file is ready. Go to the dashboard > Notifications, and click Download next to the notification to save the file on your device.
Transaction Exports
Transactions contain the operations on loyalty cards and gift cards, providing you with details on each card. Details can be viewed and exported individually, per card, or per campaign through the Transactions tab within the General section of the selected Loyalty Program or Gift Card campaign. You can find more details in the Transactions article.
The flow is similar to the ones above, where you choose the export to CSV option and select the data fields you want to export.
Available attributes in the Loyalty Program:
- ID
- Type
- Source ID
- Reason
- Amount
- Balance
- Creation Date
- Voucher ID
- Campaign ID
- Source
- Details
- Related Transaction ID
Available attributes in the Gift Card Campaign:
- ID
- Type
- Source ID
- Reason
- Amount
- Balance
- Creation Date
- Voucher ID
- Campaign ID
- Source
- Details
API exports
Visit Voucherify developer guide to learn about exports data via API.