General information

All available data can be downloaded and processed via the API. The API consists of various parameters that must be specified to get access to the wanted data.

Possible parameters for filtering:

The API allows access to all data that has been accumulated over time. A filter is applied via the corresponding parameters to obtain only the data that is needed.

Here is an example API-call:

https://www.DOMAIN.com/api//Access-Token/publisher/ID/get-statistic_daily.csv?condition[period][from]=19.12.1909&condition[period][to]=19.12.1909

In order to call the API, the domain of the requested system must first be provided. Afterwards follows "/api//" and the access token of the account. If you don't know the access token, please follow the instructions below:

Where can the access-token be found?

After the access token a "/publisher/" is appended followed by the publisher ID of the system. If the publisher ID is not known, please follow these instructions:

Where can I find the publisher id?

Then the type of API call is determined. Which types of API-calls are available can be found in the following instructions:

Welche API Aufrufe gibt es?

Finally, it can be decided in which format the data should be provided. The output of the file is possible in CSV, XLS, XML and JSON. The file extension must be adapted accordingly. The CSV file format is recommended!

Verfügbare Datenarten

file format

parameter

CSV format - seperated by comma

.csv

XLS format - default format of Microsoft Excel

.xls

XML format- extensible markup language

.xml

View API in frontend

The APIs can also be found in the frontend. In order to do so, you have to login first and afterwards navigating to the tab "API" to the point "Data API", where all interfaces are offered.


Transaction – API

For the Transaction API there are additional parameters that can be queried.

Up to this point the following call is known: […]/get-statistic_transactions.csv?[…]

Below are all additional parameters that can be queried:

Transaction status

parameter

value

description

example

condition[l:processingstate]

open

All transaction with the status “open” within the system.

condition[I:processingstate]=open

confirmed

All transaction with the status “confirmed” within the system.

condition[I:processingstate]=confirmed

paid

All transaction with the status “paid” within the system.

condition[I:processingstate]=paid

canceled

All transaction with the status “canceled” within the system.

condition[I:processingstate]=canceled

Please notice: A combination of several statuses is possible. For example:
condition[l:processingstate]=confirmed,paid


Additional Transaction API filters

parameter

value

description

example

condition[l:projects]

id of the project as integer

All transactions that are stored under the given project ID within the program.

condition[l:projects]=1234

condition[l:campaigns]

id of the campaign as integer

All transactions that are stored under the given campaign ID within the program.

condition[l:campaigns]=1

condition[timetype]

0 = creation date

1 = processing date

2 = payout date

All transactions that have been created/processed/payed out in a certain period.

condition[timetype]=1