Publisher:Doku:API:EN
General Information of the API and possible parameter for filtering:
Files can be generated as CSV, XLS and XML. Therefore you just need to change the file extension.
The exact links for the API you will find under Statistics => Export-API, where you can choose between 8 different APIs such as:
Daily statistics, Campaign statistics, project statistics, subid, referrer statistics, admedia statistics, transactions statistics, API
CSV:LINK-WITH-APIKEY/get-statistic_daily.csv?condition[period][from]=&condition[period][to]=07.11.2013
XML:LINK-WITH-APIKEY/get-statistic_daily.xml?condition[period][from]=&condition[period][to]=07.11.2013
The API of the Private Network offers you a variety of filter options.
Start date ==> condition[period][from]=01.11.2013
First day of your statistics
End date ==> condition[period][to]=07.11.2013
Last day of your statistics
Instead of the above listed parameters you can also use the following variation:
LINK-MIT-APIKEY/get-statistic_daily.csv?condition[dynamicdate]=currentmonth
condition[dynamicdate]=
currentmonth = current montth
lastmonth = last month
last10d - = the last 10 days
currentweek = the current week
Transactions – API
The transactions API offers you an additional status query:
CSV: LINK-MIT-APIKEY/ get-statistic_transactions.csv?condition[period][from]=01.12.2013&condition[period][to]=01.01.2014&condition[l:processingstate]=open
XML: LINK-MIT-APIKEY/ get-statistic_transactions.xml?condition[period][from]=01.12.2013&condition[period][to]=01.01.2014&condition[l:processingstate]=open
condition[l:processingstate]=
open = all open transactions
confirmed = all confirmed but not yet paid transactions
paid = confirmed and paid transactions
canceled =cancelled transactions
Besides you can also combine different states.
condition[l:processingstate]=confirmed,paid
By this you get an overview of all confirmed and paid transactions, separated by comma.
Other API Filter
condition[l:projects]= Your Projekt-ID (if there are more than one projects registered to your account)
condition[l:campaigns]= The campaign ID
Definition of the transaction API
<tbody> </tbody>
|
criterion |
Encoded transaction ID |
|
trackingtime |
Time of transaction |
|
advertiser_id |
Advertiser ID |
|
campaign_title |
Name des Programms (Kampagne) |
|
campaign_id |
Programm ID |
|
project_id |
Your Website/App ID (project) |
|
project_title |
Name of your website/app (project) |
|
event |
Transaction type – Lead, Sale, Bonus |
|
Payoutdate |
Empty if payment is still open, format: YYYY-MM-DD HH:MM:SS |
|
processingdate |
Empty if payment is still open, format: YYYY-MM-DD HH:MM:SS |
|
salary_id |
Internal payment ID, set to 1 if not yet paid |
|
salary |
Payment number – receipt canbe downloaded under Settings=>payments |
|
clicktime |
Time of click - format: YYYY-MM-DD HH:MM:SS |
|
subid |
In case of used click / postview subids – If no subids are used, d NONE will be shown |
|
referrer |
Click-Referrer if identified, otherwise ://NONE |
|
admedia_id |
Admedia (promotion banner) ID of the click that generated the transaction |
|
status |
0 = open | 1 = confirmed | 2 = cancelled | 3 = paid |
|
reason_of_cancellation |
cancellation reason (if there is any given) |
|
provision |
Your provision |
|
turnover |
Nett turnover |
|
trigger_id |
Event ID |
|
trigger_title |
Event name |
|
basket_count |
In case basket tracking is configured, the number of items within the basket will be shown, if no basket tracking is set the value will be 0 |
