EN - Statistics - API
- Christian Goerke
The Statistics API is used to retrieve statistical data. For this purpose, the following parameter must be appended to the API call:
API | Parameter |
|---|---|
Statistic | get-statistic_{type of statistic} |
Example: https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-statistic_{type of statistic}.csv
There are different types of statistics that can be requested. The available types are summarized in the following table:
Type of statistic | Parameter |
|---|---|
Statistics by day | get-statistic_daily |
Statistics by advertiser | get-statistic_advertiser |
Statistics by by campaigns | get-statistic_campaign |
Statistics by admedia | get-statistic_media |
Statistics by publisher | get-statistic_publisher |
Statistics by project | get-statistic_project |
Statistics by subid | get-statistic_subid |
Statistics by referrer | get-statistic_referrer |
Statistics by channel | get-statistic_channel |
Statistics by commission group | get-statistic_provisionsgroup |
Statistics by trigger | get-statistic_trigger |
Statistics by devicetype | get-statistic_devicetype |
Statistics by device | get-statistic_device |
Statistics by browser | get-statistic_browser |
Statistics by OS | get-statistic_os |
Filter
The API offers several filtering options, which are appended to the statistic request using the operation “?”
Parameter | Value | Description | Example |
|---|---|---|---|
condition[period][from] | start date | Definition of start date | condition[period][from]=19.12.1909 |
condition[period][to] | end date | Definition of end date | condition[period][to]=19.12.1909 |
condition[paymentstatus] | Payout status all = all 0 = not paid 1 = paid | Definition of payout status
| condition[paymentstatus]=all |
condition[dynamicdate] |
|
|
|
| current month | All data of the current month | condition[dynamicdate]=currentmonth |
| last month | All data of the last month | condition[dynamicdate]=lastmonth |
| current week | All data of the current week | condition[dynamicdate]=currentweek |
| last [days]
| Any value can be entered here for [days], e.g 10 for the last 10 days | condition[dynamicdate]=last10d |
condition[l:publisher] | publisher id | Defines the publishers to be filtered by. | condition[l:publisher]=1234,5678 |
condition[project_id] | project id | Defines the projects to be filtered by. | condition[project_id]=12345 |
condition[bruttodata] | true | Defines whether the figures should be downloaded as gross figures. This mainly affects the clicks and views. | condition[bruttodaten]=true |
condition[l:mandant] | client id | Defines the clients to be filtered by. | condition[l:mandant]=1 |
condition[l:advertiser] | advertiser id | Defines the advertiser to be filtered by. | condition[l:advertiser]=2,3 |
condition[l:campaigns] | campaign id | Defines the campaigns to be filtered by. | condition[l:campaigns]=1,3 |
Breakdown by additional criteria (3D statistics)
It is possible to break down the values of the statistic by additional parameters. The available breakdowns can be found in the following table:
Parameter | Value | Description | Example |
|---|---|---|---|
condition[l:criterions] | day | breakdown by day | condition[l:criterions]=day |
| publisher | breakdown by publisher | condition[l:criterions]=publisher |
| media | breakdown by admdia | condition[l:criterions]=media |
| advertiser | breakdown by advertiser | condition[l:criterions]=advertiser |
| campaign | breakdown by campaign | condition[l:criterions]=campaign |
| campaign_id | breakdown by campaign_id | condition[l:criterions]=campaign_id |
| Combination |
| condition[l:criterions]=day,publisher,media |
Adding KPIs in exports
It is possible to request additional parameters as separate columns:
Parameter | Value | Description | Example |
|---|---|---|---|
condition[l:additional_parameters] | all | Adding all available KPIs | condition[l:additional_parameters]=all |