Reporting API: Statistics
Statistical metrics
All methods for collecting statistics on partner sites and site groups return a set of metrics that include all or several of the following:
- shows - the number of times the ad was displayed on the site
- clicks - the number of clicks on the ad on the site
- requests - the number of requests to the site
- requested_banners - total number of requested site banners. You can request more than 1 banner in a request.
- responses - the number of banners fetched in response to requests
- noshows - the number of requested banners for which no ad was displayed
- fill_rate - fill rate: ratio of the fetched banners to the total number of requested benners
- amount - charged sum
- cpm - average cost per 1 ad on the site
- ctr - click-through rate; ratio of users who clicked on the ad to the total number of those who viewed it
- currency - account currency
- show_rate - the percentage of banner impressions to the number of banners in responses
- vtr - the percentage of completed views to the number of video starts multiplied by 100%
- vr - the percentage of visible views to all views by MRC
Collecting statistics on partner sites
GET {host}/api/v2/statistics/partner/pads/day.json The resource returns per-day statistics for sites and site groups.
Limits and filters are specified as GET request parameters:
Limits and filters are specified as GET request parameters:
All parameters are required.
You can request statistics for no more than 92 days and no more than 200 objects in one query.
Response structure:
Request example:
You can request statistics for no more than 92 days and no more than 200 objects in one query.
Response structure:
- items - statistics array for the specified period
- id - object identifier. One request may include statistics for one or more site or site group.
- rows - statistics array for each date
- total - overall statistics on an object for the specified period
- total - overall statistics on all objects for the specified period
Request example:
GET https://target.my.com/api/v2/statistics/partner/pads/day.json?id=3359&date_from=2017-09-20&date_to=2017-09-21Response example:
{
"items": [
{
"id": 123456,
"rows": [
{
"date": "2020-11-29",
"currency": "USD",
"shows": 50436,
"clicks": 301,
"goals": 10,
"ctr": 0.5967959394083592,
"custom": 102320,
"requests": 1205055,
"requested_banners": 1205055,
"responsed_blocks": 136810,
"responses": 136810,
"noshows": 1068245,
"amount": "35.43257",
"cpm": "0.7025253786977556",
"fill_rate": 11.353008783831443,
"show_rate": 36.86572618960602,
"vtr": 94.82252044786786,
"vr": 100
},
{
"date": "2020-11-30",
"currency": "USD",
"shows": 37123,
"clicks": 273,
"goals": 15,
"ctr": 0.7353931524930636,
"custom": 183470,
"requests": 886809,
"requested_banners": 886809,
"responsed_blocks": 75472,
"responses": 75472,
"noshows": 811337,
"amount": "117.08865",
"cpm": "3.1540729466907308",
"fill_rate": 8.51051353786441,
"show_rate": 49.18777824888701,
"vtr": 95.34674001262512,
"vr": 100
}
],
"total": {
"shows": 679125,
"clicks": 3769,
"goals": 204,
"ctr": 0.5549788330572428,
"custom": 1918334,
"requests": 13179610,
"requested_banners": 13179610,
"responsed_blocks": 1966523,
"responses": 1966523,
"noshows": 11213087,
"amount": "961.09239",
"cpm": "1.4151921811154059",
"fill_rate": 14.920949861187092,
"show_rate": 34.53430242107517,
"vtr": 94.98171612084903,
"vr": 100
}
}
],
"total": {
"shows": 1829746,
"clicks": 20699,
"goals": 1799,
"ctr": 1.131249911189859,
"custom": 8177452,
"requests": 33520764,
"requested_banners": 33520764,
"responsed_blocks": 4652199,
"responses": 4652199,
"noshows": 28868565,
"amount": "3869.97049",
"cpm": "2.115031534431555",
"fill_rate": 13.878558973178535,
"show_rate": 39.33077669291447,
"vtr": 86.06228068868805,
"vr": 100
}
}
Collecting statistics on partner site pages
GET {host}/api/v2/statistics/pad_with_sites/day.json The resource returns per-day statistics for site pages.
Limits and filters are specified as GET request parameters:
Limits and filters are specified as GET request parameters:
All parameters are required.
Collecting geo-based statistics on partner sites
GET {host}/api/v2/statistics/geo/pads/{hour|day|summary}.json The method returns partner site statistics arranged by geographical regions and time (per hour, per day, or summary).
Limits and filters are specified as GET request parameters:
Limits and filters are specified as GET request parameters:
The parameters date_from, date_to и id are required.
To see the list of all regions, use the following method: https://target.my.com/api/v2/regions.json.
Response structure:
Request example:
To see the list of all regions, use the following method: https://target.my.com/api/v2/regions.json.
Response structure:
- items - statistics array for the specified period
- id - object identifier
- rows - statistics array for each date. Includes the histogram array where data is arranged by the geographical regions specified in the geo field.
- total - overall statistics on an object for the specified period arranged by geographical data
- total - overall statistics on all objects for the specified period arranged by geographical data
Request example:
GET https://target.my.com/api/v2/statistics/geo/pads/day.json?date_from=2017-10-01&date_to=2017-10-12&id=571843Response example:
{
"items": [{
"id": 7695,
"rows": [{
"date": "2017-12-20",
"histogram": [{
"geo": 188,
"clicks": 0,
"shows": 697,
"goals": 0,
"noshows": 1,
"requests": 2390,
"requested_banners": 2390,
"responsed_blocks": 2389,
"responsed_banners": 2389,
"amount": "4.08"
},
...
{
"geo": 191,
"clicks": 0,
"shows": 5,
"goals": 0,
"noshows": 50,
"requests": 58,
"requested_banners": 58,
"responsed_blocks": 10,
"responsed_banners": 10,
"amount": "0"
}]
},
{
"date": "2017-12-21",
"histogram": [{
"geo": 188,
"clicks": 0,
"shows": 520,
"goals": 0,
"noshows": 1,
"requests": 1888,
"requested_banners": 1888,
"responsed_blocks": 1887,
"responsed_banners": 1887,
"amount": "2.57"
},
...
{
"geo": 191,
"clicks": 0,
"shows": 6,
"goals": 0,
"noshows": 64,
"requests": 88,
"requested_banners": 88,
"responsed_blocks": 25,
"responsed_banners": 25,
"amount": "0"
}]
}],
"total": {
"histogram": [{
"geo": 188,
"clicks": 0,
"shows": 1217,
"goals": 0,
"noshows": 2,
"requests": 4278,
"requested_banners": 4278,
"responsed_blocks": 4276,
"responsed_banners": 4276,
"amount": "6.65"
},
...
{
"geo": 191,
"clicks": 0,
"shows": 11,
"goals": 0,
"noshows": 114,
"requests": 146,
"requested_banners": 146,
"responsed_blocks": 35,
"responsed_banners": 35,
"amount": "0"
}]
}
}],
"total": {
"histogram": [{
"geo": 188,
"clicks": 0,
"shows": 1217,
"goals": 0,
"noshows": 2,
"requests": 4278,
"requested_banners": 4278,
"responsed_blocks": 4276,
"responsed_banners": 4276,
"amount": "6.65"
},
...
{
"geo": 191,
"clicks": 0,
"shows": 11,
"goals": 0,
"noshows": 114,
"requests": 146,
"requested_banners": 146,
"responsed_blocks": 35,
"responsed_banners": 35,
"amount": "0"
}]
}
}Was this article helpful?
Yes
No
