Reports
Reports allow you to access detailed statistics for all entities that are presented in this documentation.
Access to reports is provided to all users who have the appropriate permission in their personal account.
For getting reports, the following requests are provided:
Report for campaigns
Request:
{site_path}/{lang}/api/reports/campaign
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/campaign?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for media
Request:
{site_path}/{lang}/api/reports/media
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/media?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for sites
Request:
{site_path}/{lang}/api/reports/site
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/site?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for zones
Request:
{site_path}/{lang}/api/reports/zone
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/zone?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for pools
Request:
{site_path}/{lang}/api/reports/pool
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/pool?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for superpools
Request:
{site_path}/{lang}/api/reports/super-pool
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/super-pool?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for segments
Request:
{site_path}/{lang}/api/reports/segment
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/segment?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Access to the report is allowed only to advertisers for which data is requested оr for a user with the right to access the hourly reports of advertisers.
Request:
{site_path}/{lang}/api/reports/advertisers-hour/{advertiserID}
GET parameters list:
| date | string | Date of the initial sampling period in YYYYMMDDH format (H-hour in 24-hour format without leading zero). The data will be fetched 1 hour in advance from the specified period. By default, the initial period is set to the value of the previous hour |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | HTTP response code. Possible values:
|
| error | array |
Error data. |
| result | string | Result in csv format |
Request example:
{site_path}/{lang}/api/reports/advertisers-hour/1839110433?date=2020111815
Response example:
{
"status": 200,
"error": null,
"result":
siteID;zoneID;campaignID;mediaID;countryID;os;osVer;browser;brVer;views;clicks;cpm;cpc;spend
1831664483;1839110212;1664162812;1700281405;20;20;4;11;18;1;0;1.398837;0;1183
1520052043;1741484376;1563462602;1700281405;20;20;9;1;74;1;0;0.144259;0;122
}
}
Report for advertisers
Request:
{site_path}/{lang}/api/reports/advertisers
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/advertisers?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for advertisers RTB
Request:
{site_path}/{lang}/api/reports/advertisers-dsp
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/advertisers-dsp?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for publishers
Request:
{site_path}/{lang}/api/reports/publishers
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/publishers?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}
Report for publishers RTB
Request:
{site_path}/{lang}/api/reports/publishers-dsp
GET parameters list:
| periodStart | string | Start date of the statistics period. Default: current |
| periodEnd | string | End date of the statistics period. Default: current |
| groups | string|array | Multilevel grouping of statistics. Available Values:
|
| id | int | ID of entity for which statistics will be generated |
| ids | string|array | IDs of entities for which statistics will be generated |
| countries | string|array | Filter by country |
| regions | string|array | Filter by region |
| cities | string|array | Filter by city |
| metric | string|array | Statistics data |
| order | string | Allows you to pass the page number of the list of entities |
List of response fields 'total'
| views | int | Views |
| vp | string | Views, % |
| clicks | int | Clicks |
| cp | string | Clicks, % |
| ctr | string | CTR |
| uniqueViews | int | Unique views |
| uvp | string | Unique views, % |
| uniqueClicks | int | Unique clicks |
| ucp | string | Unique clicks, % |
| uvr | double | Unique views ratio |
| cpm | string | Cost per mille |
| cpc | string | Cost per click |
| cpa | string | Cost per action |
| spend | string | Money |
List of response fields 'items'
| group | string | the parameter by which the data in the current element is grouped |
| id | string | grouping id |
| value | string | the name of the entity by which the grouping is performed |
| total | object | statistics data. May contain all fields described in the table List of response fields 'total' |
| itemsCount | int | number of data lines |
| totalRowsCount | int | number of child (grouped) data rows |
| items | object | statistics data, each element can include all the fields described in the table List of response fields 'items' |
Response
The response is transmitted in JSON format. List of response fields:
| status | int | Request status. Possible values:
|
| error | string |
Error data. |
| result | object | Query result according to all selected parameters. Contains elements:
|
Request example:
{site_path}/{lang}/api/reports/publishers-dsp?periodStart=15-07-2020&periodEnd=15-07-2020&ids=2093693536&groups=hitDate,mediaID,campaignID,siteID&countries=43,42®ions=709,719,722&cities=711660,711390,709248&metric=views,clicks,ctr&order=-hitDate
Response example:
{
"status": 4,
"error": null,
"result": {
"groups": [
"hitDate",
"mediaID",
"campaignID",
"siteID"
],
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"itemsCount": 4,
"totalRowsCount": 5,
"items": {
"group2020-07-15": {
"group": "hitDate",
"id": "2020-07-15",
"value": "",
"total": {
"views": 871,
"vp": 0,
"clicks": 3,
"cp": 0,
"ctr": "0.34%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 5,
"itemsCount": 4,
"items": {
"group1412746748": {
"group": "mediaID",
"id": "1412746748",
"value": "my_media",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 2,
"itemsCount": 2,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "my_company",
"total": {
"views": 444,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.45%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 2,
"items": {
"group1933910528": {
"group": "siteID",
"id": "1933910528",
"value": "kino",
"total": {
"views": 21,
"vp": 0,
"clicks": 0,
"cp": 0,
"ctr": 0,
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
},
"group1335501087": {
"group": "siteID",
"id": "1335501087",
"value": "dyna",
"total": {
"views": 423,
"vp": 0,
"clicks": 2,
"cp": 0,
"ctr": "0.47%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
},
"group1200965557": {
"group": "mediaID",
"id": "1200965557",
"value": "test_media",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 1,
"itemsCount": 1,
"items": {
"group2093693536": {
"group": "campaignID",
"id": "2093693536",
"value": "test_camp",
"total": {
"views": 427,
"vp": 0,
"clicks": 1,
"cp": 0,
"ctr": "0.23%",
"uniqueViews": 0,
"uvp": 0,
"uniqueClicks": 0,
"ucp": 0,
"uvr": 0,
"cpm": 0,
"cpc": 0,
"cpa": 0,
"spend": 0
},
"totalRowsCount": 0,
"itemsCount": 1,
"items": []
}
}
}
}
}
}
}
}