How do I create automated exports?

Overview

Most of the data generated by the platform can be downloaded as XLS or CSV manually. However, you might want to export data in an automated way, for example when you want to use your own reporting tool. This article explains you what data you can import and how you should prepare an automated data export.

Creating an export URL

Structure of the export URL

To prepare your automated data import, you need to create an export URL. A basic export URL will look more or less like this:

https://export.net.yourdomain.com/f0d58125-5489-4ac3-84b2-0417a3a85f65/adm-conversionexport.csv?

Let’s go through all the elements one by one:

  • The ‘https://’ part is the protocol. Please make sure you are using a https protocol (no http) in order to secure transmission of your data.

  • The ‘export.net.yourdomain.com’ is the export domain of your platform. In most cases, the export domain will start with ‘export.net’, but if you need to be absolutely sure you need to check the platform settings under ‘configuration’ in the administration section of the main navigation menu of your admin UI.

  • The ‘f0d58125-5489-4ac3-84b2-0417a3a85f65/adm-conversionexport.csv’ element is called the path. It can be subdivided in the following elements:

    • The ‘f0d58125-5489-4ac3-84b2-0417a3a85f65’ element is the API key, which functions as access token for your export URL. Please make sure that you are working with a valid API key that gives access to the section from which you want to export data. For more information on the API key, please read this article.

    • The ‘adm-conversionexport’ part is name of the report. You will find the names of all the possible exports listed below.

    • The .csv element is the file extension. As we already mentioned, there are three available formats (XLS or CSV) for your export.

Available data

To define what data you are exporting, all you have to do is fill in the right report name. You will find these names, along with a comprehensive documentation of the output and the filters you can apply via the following links:

Applying filters

Depending on the data you are exporting, you can apply filters. These filters need to be added to the export URL using the following structure:

filter[filtername]=filtervalue

Please make sure you place the first filter immediately after the question mark in the export URL and add all further paramters by using an ampersand. You can find a complete overview of the available filters in the individual descriptions of the available reports below.

Server restraints

Due to limited server capacity, the maximum number of export files you can export is 10 per report per hour per user. There are no limits to the data volume you can export in one file, but you cannot apply a timerange longer than one year.