Data export

You can use dedicated API endpoints to export your data or download CSV files straight from the dashboard. 

Contents

  1. Exports overview
  2. Publications
  3. Redemptions
  4. Vouchers
  5. Customers
  6. Metadata
  7. Referral program exports
  8. Loyalty campaign exports
  9. Orders exports
  10. Points expirations exports
  11. Transactions exports
  12. 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 would like to 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.

Using the API, you'll use one endpoint to prepare and schedule export, and then the 2nd one to download the file. 

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, and click on the export tool. 

Choose which publication details you would like to download, and confirm with Export.

Loyalty Program

Go to the campaign dashboard > Participants, and click on the export tool.

Choose which publication details you would like to download, and confirm with  Export.

Redemptions

You can download all redemptions that were 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 (1), you can download metadata assigned to redemptions (2). 

Expand the defined fields to get an overview of included attributes.

If you would like to 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 (1), and click Export (2).

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 (1), you can download metadata assigned to vouchers (2). 

Expand the defined fields to get an overview of included attributes.

Advanced filters

If you would like to download only specific vouchers belonging to 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.

Filters browse 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. Read more about filters.

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

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 and click on the export tool located below the filters section.

You can decide which attributes will be included in your CSV file. Besides standard attributes (1), you can download metadata assigned to customers (2). 

Expand the defined fields to get an overview of included attributes. When ready, click Export to confirm.

Advanced filters

If you would like to filter and export data of a particular customer group, use filters and list customers that meet predefined criteria. Go to the Customers tab and choose  Find and apply filters.

Filters browse customers using their activity, standard (profile) data, and custom metadata. You can apply many filters in a single query. When all filters are set, confirm with Apply to view results. Read more about filters.

Once you filter customers, click  Export and decide which 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. 

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 would like to include in your file.

Click on the referral program name and go to:

  • Redemptions history tab to export all redemptions of referral codes.
  • Referrers tab to download data of referral codes publications, including owners (referrers) details.

If you would like to export only referrers that have successful referrals, you need to go to the Customers tab in your dashboard and use filters.

  1. Choose Activity. 
  2. Filter by Referred customers.
  3. Choose a referral campaign from the list.
  4. 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 would like to include in your file.

Click on the loyalty program name and go to the  Participants tab to export all loyalty cards and their owners.

If you would like to export participants with a particular score, you need to go to the Customers tab in your dashboard and use filters.

  1. Choose Activity.
  2. Filter by Loyalty points.
  3. Choose a loyalty program from the list.
  4. Define the condition (number of points on the customers' cards).

Orders 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.

When ready, click Export to confirm.

Advanced filters

If you would like to 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. Read more about filters.

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 points expirations exports

You can download all points 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.

 And 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.

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. 

Transactions exports

You can download transactions that are related to a specific loyalty card or gift card. Read more. 

The flow is similar to the ones above, where you choose the export to CSV option, choose the data fields that you would like to export.

API exports

Visit our API reference to learn about exports data via API.

  1. Create an export using the POST /exports method

    Request body

    {
    "exported_object": "points_expiration",
    "parameters": {
        "order": "-expires_at",
        "fields": [
            "id",
            "campaign_id",
            "voucher_id",
            "status",
            "expires_at",
            "points"
        ],
        "filters": {
            "junction": "and",
            "voucher_id": {
                "conditions": {
                    "$is": "v_TgIRnelL8dKiq0NS61rGV2mAozk19y1z"
                }
            }
        }
    }
}

    Response body

    {
    "id": "exp_v5w9zjcLU1aHD6iFJu4ps47W",
    "object": "export",
    "created_at": "2022-12-27T10:24:50.242Z",
    "status": "SCHEDULED",
    "channel": "API",
    "exported_object": "points_expiration",
    "parameters": {
        "order": "-expires_at",
        "fields": [
            "id",
            "campaign_id",
            "voucher_id",
            "status",
            "expires_at",
            "points"
        ],
        "filters": {
            "junction": "and",
            "voucher_id": {
                "conditions": {
                    "$is": "v_TgIRnelL8dKiq0NS61rGV2mAozk19y1z"
                }
            }
        }
    },
    "result": null,
    "user_id": null
}
  2. Retrieve the export using the export ID through the GET exports/{exportId} method. The response will store the URL of the created file in the result object.

    Request URL

    https://api.voucherify.io/v1/exports/exp_v5w9zjcLU1aHD6iFJu4ps47W

    Response body

    {
    "id": "exp_v5w9zjcLU1aHD6iFJu4ps47W",
    "object": "export",
    "created_at": "2022-12-27T10:24:50.242Z",
    "status": "DONE",
    "channel": "API",
    "exported_object": "points_expiration",
    "parameters": {
        "order": "-expires_at",
        "fields": [
            "id",
            "campaign_id",
            "voucher_id",
            "status",
            "expires_at",
            "points"
        ],
        "filters": {
            "junction": "and",
            "voucher_id": {
                "conditions": {
                    "$is": "v_TgIRnelL8dKiq0NS61rGV2mAozk19y1z"
                }
            }
        }
    },
    "result": {
        "url": "https://download.voucherify.io/v1/exports/exp_v5w9zjcLU1aHD6iFJu4ps47W?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnQiOiJzYW11ZWwuam"
    },
    "user_id": null
}
    Log in to download

    In order for the authentication to go through, you need to be logged into the Voucherify dashboard in the browser to successfully download a file.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us