Statistics

Statistics v2

The v2 statistics API methods allow you to get various statistics for advertising objects.

The v2 statistics API methods allow you to get various statistics for advertising objects.

Restrictions and filters in these methods are set using GET parameters, not in the address body, as in the V1 API.

Request restrictions

  • Statistics split by day are not returned for more than the last 365 days.
  • You can get statistics for up to 200 objects per request.

Error handling

In case of an error, a response like this is returned:

{
    "error":
    {
        "message": "message_text",
        "code": "CODE"
    }
}

Probable errors

HTTP codeCodeDescription
400ERR_WRONG_PARAMETERInvalid parameter value, or a required parameter was omitted
400ERR_LIMIT_EXCEEDEDExceeded the limit on the requested dates or number of objects
400ERR_WRONG_DATEInvalid date specified
400ERR_WRONG_BANNERSThe requested banners do not exist or are not available for this API user
400ERR_WRONG_CAMPAIGNSThe requested campaigns do not exist or are not available for this API user
400ERR_WRONG_USERSThe user does not exist or statistics on it are not available for this API user
403ERR_ACCESS_DENIEDNo permissions to access the API method
404ERR_WRONG_RESOURCEThe API method does not exist
500ERR_INTERNALInternal server error

Methods

General statistics

GET {host}/api/v2/statistics/{banners|campaigns|users}/{day|summary}.json

The resource returns total statistics for the entire time of rollback or daily statistics for the selected period for accounts, campaigns, and banners.

Restrictions and filters are set using GET parameters:

ParameterFormatDefault valueDescription
date_fromYYYY-MM-DD Start date. Only for day.json.
date_toYYYY-MM-DD End date (inclusive). Only for day.json.
idcomma-separated list of IDs List of IDs of banners, campaigns, or users.
metricscomma-separated list of text IDsbaseList of sets of metrics. Available option: all, base, events, video, uniques, tps, playable, romi.
attributionimpressiondefaultto attribute at the time of the event, the time of the impression. Ignored for summary

All parameters except metrics are required.

You can get all statistical metrics or specific datasets in a single query.

1. base - basic metrics:

  • shows - number of impressions;
  • clicks - number of clicks;
  • goals - the number of goals achieved (goals Top@Mail.ru for websites and mobile app installs);
  • spent - write-offs;
  • cpm - average deduction per 1000 views;
  • cpc - the average write-off in 1 click;
  • cpa - the average write-off for achieving 1 goal;
  • ctr - the percentage of the number of clicks to the number of views;
  • cr - the percentage of the number of completed goals to the number of clicks.

2. events - metrics for advertised messages in the social media feed:

  • opening_app - number of openings of the advertised social network app;
  • opening_post - the number of openings of the advertised message in the social media feed;
  • moving_into_group - the number of clicks on the group page from the advertised message;
  • clicks_on_external_url - number of clicks on the external link in the advertised message;
  • launching_video - the number of launches the video in the advertised message;
  • comments - the number of clicks per Comment button;
  • joins - the number of joins to the group via the advertised message;
  • likes - the number of likes of the advertised message;
  • shares - the number of "Share" actions for the advertised message;
  • votes - the number of voting actions in the advertised message.

3. unique metrics for the number of unique users:

  • reach - obsolete metric, now it's always 0;
  • total - the number of unique users who saw ads from the selected campaign from the start of the advertising campaign at the end of the selected period;
  • increment - increase in the number of unique users for the selected period;
  • initial_total - the number of unique users who saw ads from the selected campaign from the start of the advertising campaign at the beginning of the selected period (not including period_date_start)
  • frequency - daily ad display frequency for the selected period
  • frequency_total - deprecated metric, value is the same as in frequency.

Note: For advertising campaigns with a broadcast pause of more than 90 days, statistics on unique users will not be relevant.

4. video-metrics for video ads:

  • started - number of starts of video playback;
  • paused-the number of pauses in video playback;
  • resumed_after_pause - the amount of video playback after a pause;
  • fullscreen_on - the number of times the full-screen video playback mode is enabled;
  • fullscreen_off - the number of times the full-screen video playback mode is turned off;
  • sound_turned_off - the number of video sound offs;
  • sound_turned_on - the number of video audio inclusions;
  • viewed_10_seconds - number of views of the first 10 seconds of the video;
  • viewed_25_percent - number of views of the first 25% of the video duration;
  • viewed_50_percent - number of views of the first 50% of the video duration;
  • viewed_75_percent - number of views of the first 75% of the video duration;
  • viewed_100_percent - number of views 100% of the video duration;
  • viewed_10_seconds_rate-percentage of views with the first 10 seconds of video reached;
  • viewed_25_percent_rate-percentage of views with the first 25% of the video duration reached;
  • viewed_50_percent_rate-percentage of views with the first 50% of the video duration reached;
  • viewed_75_percent_rate-percentage of views with the first 75% of the video duration reached;
  • viewed_100_percent_rate - the percentage of hits with the achievement of 100% of the video duration;
  • depth_of_view - average video viewing depth (as a percentage);
  • view_10_seconds_cost - average cost of viewing the first 10 seconds of video;
  • viewed_25_percent_cost - average cost of viewing the first 25% of the video duration;
  • viewed_50_percent_cost - average cost of viewing the first 50% of the video duration;
  • viewed_75_percent_cost - average cost of viewing the first 75% of the video duration;
  • viewed_100_percent_cost - the average cost of viewing 100% of the video duration.

5. carousel-statistics for individual slides of the advertising carousel (N - from 1 to the number of slides):

  • slide_N_shows - number of slide impressions N;
  • slide_N_clicks - number of clicks on the slide N;
  • slide_N_ctr-percentage of the number of clicks to the number of views on the slide N;

6. tps - statistics on the additional write-offs:

  • tps-additional charges for using the moat service;
  • tpd-additional charges for using third-party data (from dmp).

7. moat-statistics based on moat service data:

  • impressions - number of impressions;
  • in_view, the number of visible impressions;
  • never_focused - number of impressions in an inactive tab;
  • never_visible - number of impressions outside the viewport;
  • never_50_perc_visible - the number of impressions with the ad's visibility zone less than 50%;
  • never_1_sec_visible - the number of impressions with a visibility duration of less than 1 second;
  • human_impressions - the number of verified impressions;
  • impressions_analyzed - analyzed the number of impressions;
  • in_view_percent - the percentage of visible impressions;
  • human_and_viewable_perc - the percentage of verified impressions;
  • never_focused_percent-percentage of impressions in an inactive tab;
  • never_visible_percent-percentage of impressions outside the viewport;
  • never_50_perc_visible_percent-percentage of impressions with the ad's visibility zone less than 50%;
  • never_1_sec_visible_percent-percentage of impressions with a visibility duration of less than 1 second;
  • in_view_diff_percent-difference in the number of visible impressions;
  • active_in_view_time - average time when the ad is in the viewport;
  • attention_quality - the level of engagement.

8. playable - metrics for Playable Ads:

  • playable_game_open-opening the game;
  • playable_game_close-closing the game;
  • playable_call_to_action-clicks.

9. romi-return on investment metrics:

  • value - the specified event value
  • romi-return on investment indicator
  • adv_cost_share-share of advertising expenses

10. uniques_video - unique metrics for video ads:

  • started - number of unique video playback starts;
  • viewed_10_seconds - number of unique views for the first 10 seconds of the video;
  • viewed_25_percent - number of unique views for the first 25% of the video duration;
  • viewed_50_percent - the number of unique views of the first 50% of the video duration;
  • viewed_75_percent - the number of unique views for the first 75% of the video duration;
  • viewed_100_percent - number of unique views for 100% of the video duration;
  • viewed_10_seconds_rate - percentage of unique views reaching the first 10 seconds of the video;
  • viewed_25_percent_rate - percentage of unique views reaching the first 25% of the video duration;
  • viewed_50_percent_rate - percentage of unique views reaching the first 50% of the video duration;
  • viewed_75_percent_rate - percentage of unique views reaching the first 75% of the video duration;
  • viewed_100_percent_rate - percentage of unique views that reach 100% of the video duration;
  • depth_of_view - average depth of unique video views (in percent);

Response structure:

  • items - array of statistics for the requested period
    • id - object ID
    • rows - array of statistics for a specific date
      • date - date
      • metrics - arrays of requested metrics
    • total - total object statistics for the requested period
  • total - total statistics for all objects for the requested period

Example request:

{
    "items": [
        {
            "id": 8372481,
            "rows": [
                {
                    "date": "2017-10-30",
                    "base": {
                        "shows": 75881,
                        "clicks": 270,
                        "goals": 0,
                        "spent": "23328.92",
                        "a_amount": "23328.92",
                        "n_amount": "0",
                        "cpm": "307.44",
                        "cpc": "86.4",
                        "cpa": "0",
                        "ctr": 0.355820297571197,
                        "cr": 0
                    },
                    "events": {
                        "opening_app": 0,
                        "opening_post": 438,
                        "moving_into_group": 8,
                        "clicks_on_external_url": 5,
                        "launching_video": 64707,
                        "comments": 3,
                        "joinings": 0,
                        "likes": 22,
                        "shares": 0,
                        "votings": 0,
                        "sending_form": 0
                    },
                    "uniques": {
                        "reach": 0,
                        "total": 786752,
                        "increment": 53327,
                        "frequency": 1.1433026970016573
                    },
                    "uniques_video": {
                        "started": 2309,
                        "viewed_10_seconds": 1630,
                        "viewed_25_percent": 1587,
                        "viewed_50_percent": 1365,
                        "viewed_75_percent": 1132,
                        "viewed_100_percent": 874,
                        "viewed_10_seconds_rate": 70.59333044608054,
                        "viewed_25_percent_rate": 68.73105240363793,
                        "viewed_50_percent_rate": 59.116500649631874,
                        "viewed_75_percent_rate": 49.02555218709398,
                        "viewed_100_percent_rate": 37.851883932438284,
                        "depth_of_view": 4.227201418729964
                    },
                    "video": {
                        "started": 80266,
                        "paused": 233,
                        "resumed_after_pause": 68,
                        "fullscreen_on": 13,
                        "fullscreen_off": 21,
                        "sound_turned_off": 11,
                        "sound_turned_on": 22,
                        "viewed_10_seconds": 0,
                        "viewed_25_percent": 33684,
                        "viewed_50_percent": 25182,
                        "viewed_75_percent": 20488,
                        "viewed_100_percent": 18142,
                        "viewed_10_seconds_rate": 0,
                        "viewed_25_percent_rate": 41.965464829442105,
                        "viewed_50_percent_rate": 31.373184162659157,
                        "viewed_75_percent_rate": 25.525128946253705,
                        "viewed_100_percent_rate": 22.602347195574715,
                        "depth_of_view": 32.12134790000132,
                        "measurement_rate": 87.5,
                        "vr": 78.57,
                        "viewed_10_seconds_cost": "0",
                        "viewed_25_percent_cost": "0.69",
                        "viewed_50_percent_cost": "0.93",
                        "viewed_75_percent_cost": "1.14",
                        "viewed_100_percent_cost": "1.29"
                    },
                    "carousel": {
                        "slide_1_clicks": 0,
                        "slide_1_shows": 0,
                        "slide_2_clicks": 0,
                        "slide_2_shows": 0,
                        "slide_3_clicks": 0,
                        "slide_3_shows": 0,
                        "slide_4_clicks": 0,
                        "slide_4_shows": 0,
                        "slide_5_clicks": 0,
                        "slide_5_shows": 0,
                        "slide_6_clicks": 0,
                        "slide_6_shows": 0,
                        "slide_1_ctr": 0,
                        "slide_2_ctr": 0,
                        "slide_3_ctr": 0,
                        "slide_4_ctr": 0,
                        "slide_5_ctr": 0,
                        "slide_6_ctr": 0
                    },
                    "playable": {
                        "playable_game_open": 67,
                        "playable_game_close": 75,
                        "playable_call_to_action": 24
                    },
                    "tps": {
                        "tps": "758.81",
                        "tpd": "0"
                    },
                    "moat": {
                        "impressions": 529459,
                        "in_view": 91454,
                        "never_focused": 7005,
                        "never_visible": 410753,
                        "never_50_perc_visible": 4658,
                        "never_1_sec_visible": 15589,
                        "human_impressions": 529973,
                        "impressions_analyzed": 529973,
                        "in_view_percent": 17.273104,
                        "human_and_viewable_perc": 17.273104,
                        "never_focused_percent": 1.3230486,
                        "never_visible_percent": 77.57976,
                        "never_50_perc_visible_percent": 0.8797659,
                        "never_1_sec_visible_percent": 2.9443262,
                        "in_view_diff_percent": -17.028236,
                        "active_in_view_time": 0,
                        "attention_quality": 0
                    },
                    "romi": {
                        "value": "2479.5",
                        "romi": 188.5152431929253,
                        "adv_cost_share": 34.66021375277274
                    },
                    "custom_event": {
	                "custom_event_100": {
		            "alias": "",
		            "count": 0
	                },
	                "custom_event_1116": {
		            "alias": "Transition after reading the article",
		            "count": 1497
	                }
                    }
                }
            ],
            "total": {
                "base": {
                    "shows": 75881,
                    "clicks": 270,
                    "goals": 0,
                    "spent": "23328.92",
                    "a_amount": "23328.92",
                    "n_amount": "0",
                    "cpm": "307.44",
                    "cpc": "86.4",
                    "cpa": "0",
                    "ctr": 0.355820297571197,
                    "cr": 0
                },
                "events": {
                    "opening_app": 0,
                    "opening_post": 438,
                    "moving_into_group": 8,
                    "clicks_on_external_url": 5,
                    "launching_video": 64707,
                    "comments": 3,
                    "joinings": 0,
                    "likes": 22,
                    "shares": 0,
                    "votings": 0,
                    "sending_form": 0
                },
                "uniques": {
                    "reach": 0,
                    "total": 786752,
                    "initial_total": 105,
                    "increment": 53327,
                    "frequency": 1.4229377238547078
                    "frequency_total": 17.937582846444224
                },                    
                "uniques_video": {
                    "started": 2309,
                    "viewed_10_seconds": 1630,
                    "viewed_25_percent": 1587,
                    "viewed_50_percent": 1365,
                    "viewed_75_percent": 1132,
                    "viewed_100_percent": 874,
                    "viewed_10_seconds_rate": 70.59333044608054,
                    "viewed_25_percent_rate": 68.73105240363793,
                    "viewed_50_percent_rate": 59.116500649631874,
                    "viewed_75_percent_rate": 49.02555218709398,
                    "viewed_100_percent_rate": 37.851883932438284,
                    "depth_of_view": 4.227201418729964
                },
                "video": {
                    "started": 80266,
                    "paused": 233,
                    "resumed_after_pause": 68,
                    "fullscreen_on": 13,
                    "fullscreen_off": 21,
                    "sound_turned_off": 11,
                    "sound_turned_on": 22,
                    "viewed_10_seconds": 0,
                    "viewed_25_percent": 33684,
                    "viewed_50_percent": 25182,
                    "viewed_75_percent": 20488,
                    "viewed_100_percent": 18142,
                    "viewed_10_seconds_rate": 0,
                    "viewed_25_percent_rate": 41.965464829442105,
                    "viewed_50_percent_rate": 31.373184162659157,
                    "viewed_75_percent_rate": 25.525128946253705,
                    "viewed_100_percent_rate": 22.602347195574715,
                    "vr": 78.57,
                    "depth_of_view": 32.12134790000132,
                    "viewed_10_seconds_cost": "0",
                    "viewed_25_percent_cost": "0.69",
                    "viewed_50_percent_cost": "0.93",
                    "viewed_75_percent_cost": "1.14",
                    "viewed_100_percent_cost": "1.29"
                },
                "carousel": {
                    "slide_1_clicks": 0,
                    "slide_1_shows": 0,
                    "slide_2_clicks": 0,
                    "slide_2_shows": 0,
                    "slide_3_clicks": 0,
                    "slide_3_shows": 0,
                    "slide_4_clicks": 0,
                    "slide_4_shows": 0,
                    "slide_5_clicks": 0,
                    "slide_5_shows": 0,
                    "slide_6_clicks": 0,
                    "slide_6_shows": 0,
                    "slide_1_ctr": 0,
                    "slide_2_ctr": 0,
                    "slide_3_ctr": 0,
                    "slide_4_ctr": 0,
                    "slide_5_ctr": 0,
                    "slide_6_ctr": 0
                },
                "playable": {
                    "playable_game_open": 67,
                    "playable_game_close": 75,
                    "playable_call_to_action": 24
                },
                "tps": {
                    "tps": "758.81",
                    "tpd": "0"
                },
                "moat": {
                    "impressions": 529459,
                    "in_view": 91454,
                    "never_focused": 7005,
                    "never_visible": 410753,
                    "never_50_perc_visible": 4658,
                    "never_1_sec_visible": 15589,
                    "human_impressions": 529973,
                    "impressions_analyzed": 529973,
                    "in_view_percent": 17.273104,
                    "human_and_viewable_perc": 17.273104,
                    "never_focused_percent": 1.3230486,
                    "never_visible_percent": 77.57976,
                    "never_50_perc_visible_percent": 0.8797659,
                    "never_1_sec_visible_percent": 2.9443262,
                    "in_view_diff_percent": -17.028236,
                    "active_in_view_time": 0,
                    "attention_quality": 0
                },
                "romi": {
                    "value": "2479.5",
                    "romi": 188.5152431929253,
                    "adv_cost_share": 34.66021375277274
                },
                "custom_event": {
	            "custom_event_100": {
		        "alias": "",
		        "count": 0
	            },
	            "custom_event_1116": {
		        "alias": "Transition after reading the article",
		        "count": 1497
	            }
                }
            }
        }
    ],
    "total": {
        "base": {
            "shows": 75881,
            "clicks": 270,
            "goals": 0,
            "spent": "23328.92",
            "a_amount": "23328.92",
            "n_amount": "0",
            "cpm": "307.44",
            "cpc": "86.4",
            "cpa": "0",
            "ctr": 0.355820297571197,
            "cr": 0
        },
        "events": {
            "opening_app": 0,
            "opening_post": 438,
            "moving_into_group": 8,
            "clicks_on_external_url": 5,
            "launching_video": 64707,
            "comments": 3,
            "joinings": 0,
            "likes": 22,
            "shares": 0,
            "votings": 0,
            "sending_form": 0
        },
        "uniques": {
            "reach": 11425,
            "total": 1125,
            "initial_total": 105,
            "increment": 1020,
            "frequency": 8.89287
        },
        "uniques_video": {
            "started": 2309,
            "viewed_10_seconds": 1630,
            "viewed_25_percent": 1587,
            "viewed_50_percent": 1365,
            "viewed_75_percent": 1132,
            "viewed_100_percent": 874,
            "viewed_10_seconds_rate": 70.59333044608054,
            "viewed_25_percent_rate": 68.73105240363793,
            "viewed_50_percent_rate": 59.116500649631874,
            "viewed_75_percent_rate": 49.02555218709398,
            "viewed_100_percent_rate": 37.851883932438284,
            "depth_of_view": 4.227201418729964
        },
        "video": {
            "started": 80266,
            "paused": 233,
            "resumed_after_pause": 68,
            "fullscreen_on": 13,
            "fullscreen_off": 21,
            "sound_turned_off": 11,
            "sound_turned_on": 22,
            "viewed_10_seconds": 0,
            "viewed_25_percent": 33684,
            "viewed_50_percent": 25182,
            "viewed_75_percent": 20488,
            "viewed_100_percent": 18142,
            "viewed_10_seconds_rate": 0,
            "viewed_25_percent_rate": 41.965464829442105,
            "viewed_50_percent_rate": 31.373184162659157,
            "viewed_75_percent_rate": 25.525128946253705,
            "viewed_100_percent_rate": 22.602347195574715,
            "depth_of_view": 32.12134790000132,
            "viewed_10_seconds_cost": "0",
            "viewed_25_percent_cost": "0.69",
            "viewed_50_percent_cost": "0.93",
            "viewed_75_percent_cost": "1.14",
            "viewed_100_percent_cost": "1.29"
        },
        "carousel": {
            "slide_1_clicks": 0,
            "slide_1_shows": 0,
            "slide_2_clicks": 0,
            "slide_2_shows": 0,
            "slide_3_clicks": 0,
            "slide_3_shows": 0,
            "slide_4_clicks": 0,
            "slide_4_shows": 0,
            "slide_5_clicks": 0,
            "slide_5_shows": 0,
            "slide_6_clicks": 0,
            "slide_6_shows": 0,
            "slide_1_ctr": 0,
            "slide_2_ctr": 0,
            "slide_3_ctr": 0,
            "slide_4_ctr": 0,
            "slide_5_ctr": 0,
            "slide_6_ctr": 0
        },
        "playable": {
            "playable_game_open": 67,
            "playable_game_close": 75,
            "playable_call_to_action": 24
        },
        "tps": {
            "tps": "758.81",
            "tpd": "0"
        },
        "moat": {
            "impressions": 529459,
            "in_view": 91454,
            "never_focused": 7005,
            "never_visible": 410753,
            "never_50_perc_visible": 4658,
            "never_1_sec_visible": 15589,
            "human_impressions": 529973,
            "impressions_analyzed": 529973,
            "in_view_percent": 17.273104,
            "human_and_viewable_perc": 17.273104,
            "never_focused_percent": 1.3230486,
            "never_visible_percent": 77.57976,
            "never_50_perc_visible_percent": 0.8797659,
            "never_1_sec_visible_percent": 2.9443262,
            "in_view_diff_percent": -17.028236,
            "active_in_view_time": 0,
            "attention_quality": 0
        },
        "romi": {
            "value": "2479.5",
            "romi": 188.5152431929253,
            "adv_cost_share": 34.66021375277274
        },
        "custom_event": {
	    "custom_event_100": {
	        "alias": "",
                "count": 0
            },
	    "custom_event_1116": {
	        "alias": "Transition after reading the article",
	        "count": 1497
	    }
        }
    }
}

General statistics with pagination

GET {host} / api / v3 / statistics / {banners | campaigns | users} /day.json

The resource returns summary statistics for the selected period for accounts, campaigns, banners with pagination.

Restrictions and filters are set using GET parameters:

Parameter Format Default Description
date_fromYYYY-MM-DD& nbsp;Start date.
date_toYYYY-MM-DDCurrent dateEnd date (inclusive).
idcomma separated list of identifiers& nbsp;List of banner, campaign, or user IDs.
id_necomma separated list of identifiers& nbsp;List of banner, campaign, or user IDs with negation.
fieldslist of requested metrics or fields in metric or metric format. field_name comma separatedbaseList of metric sets. Available metrics: all, base, events, uniques, video, carousel, tps, moat, playable, romi.
attributionimpressionconversionAttribute by event time, display time. Available options: conversion, impression
banner_statuscomma separated list of statuses. Available options: all, active, blocked, deleted.allList of banner statuses, available for statistics on campaigns and banners.
banner_status_necomma separated list of statuses. Available options: all, active, blocked, deleted.allList of banner statuses with negation, available for campaign and banner statistics.
campaign_statuscomma separated list of statuses. Available options: all, active, blocked, deleted.allList of campaign statuses, available for campaign and banner statistics.
campaign_status_necomma separated list of statuses. Available options: all, active, blocked, deleted.allList of campaign statuses with denial. Available for campaign and banner statistics.
campaign_idcomma separated list of identifiers& nbsp;List of campaign IDs. Available for banner statistics.
campaign_id_necomma separated list of identifiers& nbsp;List of campaign IDs with negation. Available for banner statistics.
package_idcomma separated list of identifiers& nbsp;List of package identifiers. Available for banner statistics.
package_id_necomma separated list of identifiers& nbsp;Negated list of package ids. Available for campaign and banner statistics.
sort_byfield in the format metric.field_name& nbsp;Field by which identifiers of campaigns, banners or users will be sorted. Available metrics: base, events, video, carousel, tps, moat, playable, romi.
dstring fieldascSort direction. Available options: asc, desc
limitinteger from 1 to 25020Number of objects to send.
offsetinteger0Offset.

The date_from parameter is required.

In one request, you can get both all statistical metrics and specific sets. & nbsp;

    • shows - number of impressions;
    • clicks & nbsp; - number of clicks;
    • goals - the number of goals achieved (goals Top@Mail.ru & nbsp; for sites and installations for mobile applications);
    • spent - write-offs;
    • cpm - average write-off per 1000 views;
    • cpc - average write-off per click;
    • cpa - average write-off for achieving 1 goal;
    • ctr - the percentage of clicks to views;
    • cr - percentage of the number of goals achieved to the number of clicks.
    • opening_app - the number of times the advertised social media application has been opened;
    • opening_post - the number of times the advertised post has been opened in the social media feed;
    • moving_into_group - the number of clicks to the group page from the advertised message;
    • clicks_on_external_url - the number of clicks on the external link in the advertised message;
    • launching_video - number of video launches in the advertised post;
    • comments - the number of comments left in the advertised post;
    • joinings - the number of group joins through the advertised message;
    • likes - the number of likes for the advertised post;
    • shares - number of Share actions for the advertised post;
    • votings - the number of voting actions in the advertised post.
    • reach - obsolete metric, now it's always returned 0;
    • total - the number of unique users who saw ads from the selected campaign from the start of the advertising campaign to the end of the selected period;
    • increment - increase in the number of unique users for the selected period;
    • initial_total - number of unique users who saw ads from the selected campaign from the start of the advertising campaign to the beginning of the selected period (not including period_date_start)
    • frequency - daily ad display frequency for the selected period
    • frequency_total - deprecated metric, value is the same as in frequency

    Note: For advertising campaigns with a broadcast pause of more than 90 days, statistics on unique users will not be relevant.

    • started - the number of starts of video playback;
    • paused - number of pauses for video playback;
    • resumed_after_pause - amount of video playback after pause;
    • fullscreen_on - the number of times fullscreen video playback is enabled;
    • fullscreen_off - the number of times fullscreen video playback is turned off;
    • sound_turned_off - the number of times the video sound is turned off;
    • sound_turned_on - the number of times the video sound is turned on;
    • viewed_10_seconds - the number of views for the first 10 seconds of the video;
    • viewed_25_percent - the number of views for the first 25% of the video duration;
    • viewed_50_percent - the number of views for the first 50% of the video duration;
    • viewed_75_percent - the number of views for the first 75% of the video duration;
    • viewed_100_percent - number of views 100% of video duration;
    • viewed_10_seconds_rate - the percentage of views reaching the first 10 seconds of the video;
    • viewed_25_percent_rate - the percentage of views reaching the first 25% of the video duration;
    • viewed_50_percent_rate - percentage of views reaching the first 50% of the video duration;
    • viewed_75_percent_rate - the percentage of views reaching the first 75% of the video duration;
    • viewed_100_percent_rate - the percentage of views reaching 100% of the video duration;
    • depth_of_view - average video viewing depth (in percent);
    • view_10_seconds_cost - average cost of viewing the first 10 seconds of the video;
    • viewed_25_percent_cost - the average cost of viewing the first 25% of the video duration;
    • viewed_50_percent_cost - the average cost of viewing the first 50% of the video duration;
    • viewed_75_percent_cost - the average cost of viewing the first 75% of the video duration;
    • viewed_100_percent_cost - average cost per view & nbsp; 100% of video duration.
    • slide_N_shows - number of slide displays N;
    • slide_N_clicks - number of clicks on the slide N;
    • slide_N_ctr - the percentage of the number of clicks to the number of views on slide N;
    • tps - additional charges for using the moat service;
    • tpd - additional charges for using third-party data (from dmp). & nbsp;
    • impressions - number of impressions;
    • in_view - the number of visible impressions;
    • never_focused - the number of impressions in the inactive tab;
    • never_visible - the number of impressions out of sight;
    • never_50_perc_visible - the number of impressions with ad visibility less than 50%;
    • never_1_sec_visible - the number of impressions with a visibility duration of less than 1 second;
    • human_impressions - the number of verified impressions;
    • impressions_analyzed - the number of analyzed impressions;
    • in_view_percent - the percentage of visible impressions;
    • human_and_viewable_perc - the percentage of verified impressions;
    • never_focused_percent - the percentage of impressions in the inactive tab;
    • never_visible_percent - percentage of impressions out of sight;
    • never_50_perc_visible_percent - percentage of & nbsp; impressions with ad visibility less than 50%;
    • never_1_sec_visible_percent - percentage of & nbsp; impressions with visibility less than 1 second;
    • in_view_diff_percent - the difference in the number of visible impressions;
    • active_in_view_time - average time the ad spends in the visibility range;
    • attention_quality - level of engagement;
    • playable_game_open - opening the game;
    • playable_game_close - close the game;
    • playable_call_to_action - clicks;
    • value - specified value of the event
    • romi - return on investment
    • adv_cost_share - ad spend share
    • started - number of unique video playback starts;
    • viewed_10_seconds - number of unique views for the first 10 seconds of the video;
    • viewed_25_percent - number of unique views for the first 25% of the video duration;
    • viewed_50_percent - number of unique views for the first 50% of the video duration;
    • viewed_75_percent - number of unique views for the first 75% of the video duration;
    • viewed_100_percent - number of unique views for the first 100% of the video duration;
    • viewed_10_seconds_rate - percentage of unique views reaching the first 10 seconds of the video;
    • viewed_25_percent_rate - percentage of unique views reaching the first 25% of the video duration;
    • viewed_50_percent_rate - percentage of unique views reaching the first 50% of the video duration;
    • viewed_75_percent_rate - percentage of unique views reaching the first 75% of the video duration;
    • viewed_100_percent_rate - percentage of unique views reaching the first 100% of the video duration;
    • depth_of_view - average depth of unique video views (in percent);

Response structure:

  • items - an array of statistics for the requested period
    • id - object identifier
    • user_id is the identifier of the user who owns the object. Available for campaigns and banners.
    • total - total statistics for the object for the requested period
  • total - summary statistics for all objects for the requested period
  • limit - limit the number of objects sent
  • offset - offset
  • count - number of given objects

Request example:

{
    "items": [
        {
            "id": 8372481,
            "user_id": 55555,
            "total": {
                "base": {
                    "shows": 75881,
                    "clicks": 270,
                    "goals": 0,
                    "spent": "23328.92",
                    "a_amount": "23328.92",
                    "n_amount": "0",
                    "cpm": "307.44",
                    "cpc": "86.4",
                    "cpa": "0",
                    "ctr": 0.355820297571197,
                    "cr": 0
                },
                "events": {
                    "opening_app": 0,
                    "opening_post": 438,
                    "moving_into_group": 8,
                    "clicks_on_external_url": 5,
                    "launching_video": 64707,
                    "comments": 3,
                    "joinings": 0,
                    "likes": 22,
                    "shares": 0,
                    "votings": 0,
                    "sending_form": 0
                },
                "uniques": {
                    "reach": 0,
                    "total": 786752,
                    "increment": 53327,
                    "initial_total": 105,
                    "frequency": 1.4229377238547078
                    "frequency_total": 17.937582846444224
                },
                "uniques_video": {
                    "started": 2309,
                    "viewed_10_seconds": 1630,
                    "viewed_25_percent": 1587,
                    "viewed_50_percent": 1365,
                    "viewed_75_percent": 1132,
                    "viewed_100_percent": 874,
                    "viewed_10_seconds_rate": 70.59333044608054,
                    "viewed_25_percent_rate": 68.73105240363793,
                    "viewed_50_percent_rate": 59.116500649631874,
                    "viewed_75_percent_rate": 49.02555218709398,
                    "viewed_100_percent_rate": 37.851883932438284,
                    "depth_of_view": 4.227201418729964
                },
                "video": {
                    "started": 80266,
                    "paused": 233,
                    "resumed_after_pause": 68,
                    "fullscreen_on": 13,
                    "fullscreen_off": 21,
                    "sound_turned_off": 11,
                    "sound_turned_on": 22,
                    "viewed_10_seconds": 0,
                    "viewed_25_percent": 33684,
                    "viewed_50_percent": 25182,
                    "viewed_75_percent": 20488,
                    "viewed_100_percent": 18142,
                    "viewed_10_seconds_rate": 0,
                    "viewed_25_percent_rate": 41.965464829442105,
                    "viewed_50_percent_rate": 31.373184162659157,
                    "viewed_75_percent_rate": 25.525128946253705,
                    "viewed_100_percent_rate": 22.602347195574715,
                    "vr": 78.57,
                    "depth_of_view": 32.12134790000132,
                    "viewed_10_seconds_cost": "0",
                    "viewed_25_percent_cost": "0.69",
                    "viewed_50_percent_cost": "0.93",
                    "viewed_75_percent_cost": "1.14",
                    "viewed_100_percent_cost": "1.29"
                },
                "carousel": {
                    "slide_1_clicks": 0,
                    "slide_1_shows": 0,
                    "slide_2_clicks": 0,
                    "slide_2_shows": 0,
                    "slide_3_clicks": 0,
                    "slide_3_shows": 0,
                    "slide_4_clicks": 0,
                    "slide_4_shows": 0,
                    "slide_5_clicks": 0,
                    "slide_5_shows": 0,
                    "slide_6_clicks": 0,
                    "slide_6_shows": 0,
                    "slide_1_ctr": 0,
                    "slide_2_ctr": 0,
                    "slide_3_ctr": 0,
                    "slide_4_ctr": 0,
                    "slide_5_ctr": 0,
                    "slide_6_ctr": 0
                },
                "playable": {
                    "playable_game_open": 67,
                    "playable_game_close": 75,
                    "playable_call_to_action": 24
                },
                "tps": {
                    "tps": "758.81",
                    "tpd": "0"
                },
                "moat": {
                    "impressions": 529459,
                    "in_view": 91454,
                    "never_focused": 7005,
                    "never_visible": 410753,
                    "never_50_perc_visible": 4658,
                    "never_1_sec_visible": 15589,
                    "human_impressions": 529973,
                    "impressions_analyzed": 529973,
                    "in_view_percent": 17.273104,
                    "human_and_viewable_perc": 17.273104,
                    "never_focused_percent": 1.3230486,
                    "never_visible_percent": 77.57976,
                    "never_50_perc_visible_percent": 0.8797659,
                    "never_1_sec_visible_percent": 2.9443262,
                    "in_view_diff_percent": -17.028236,
                    "active_in_view_time": 0,
                    "attention_quality": 0
                },
                "romi": {
                    "value": "2479.5",
                    "romi": 188.5152431929253,
                    "adv_cost_share": 34.66021375277274
                },
                "custom_event": {
	            "custom_event_100": {
		        "alias": "",
		        "count": 0
	            },
	            "custom_event_1116": {
		        "alias": "Transition after reading the article",
		        "count": 1497
	            }
                }
            }
        }
    ],
    "total": {
        "base": {
            "shows": 75881,
            "clicks": 270,
            "goals": 0,
            "spent": "23328.92",
            "a_amount": "23328.92",
            "n_amount": "0",
            "cpm": "307.44",
            "cpc": "86.4",
            "cpa": "0",
            "ctr": 0.355820297571197,
            "cr": 0
        },
        "events": {
            "opening_app": 0,
            "opening_post": 438,
            "moving_into_group": 8,
            "clicks_on_external_url": 5,
            "launching_video": 64707,
            "comments": 3,
            "joinings": 0,
            "likes": 22,
            "shares": 0,
            "votings": 0,
            "sending_form": 0
        },
        "uniques": {
            "reach": 11425,
            "total": 1125,
            "initial_total": 105,
            "increment": 1020,
            "frequency": 8.89287
        },
        "uniques_video": {
            "started": 2309,
            "viewed_10_seconds": 1630,
            "viewed_25_percent": 1587,
            "viewed_50_percent": 1365,
            "viewed_75_percent": 1132,
            "viewed_100_percent": 874,
            "viewed_10_seconds_rate": 70.59333044608054,
            "viewed_25_percent_rate": 68.73105240363793,
            "viewed_50_percent_rate": 59.116500649631874,
            "viewed_75_percent_rate": 49.02555218709398,
            "viewed_100_percent_rate": 37.851883932438284,
            "depth_of_view": 4.227201418729964
        },
        "video": {
            "started": 80266,
            "paused": 233,
            "resumed_after_pause": 68,
            "fullscreen_on": 13,
            "fullscreen_off": 21,
            "sound_turned_off": 11,
            "sound_turned_on": 22,
            "viewed_10_seconds": 0,
            "viewed_25_percent": 33684,
            "viewed_50_percent": 25182,
            "viewed_75_percent": 20488,
            "viewed_100_percent": 18142,
            "viewed_10_seconds_rate": 0,
            "viewed_25_percent_rate": 41.965464829442105,
            "viewed_50_percent_rate": 31.373184162659157,
            "viewed_75_percent_rate": 25.525128946253705,
            "viewed_100_percent_rate": 22.602347195574715,
            "depth_of_view": 32.12134790000132,
            "viewed_10_seconds_cost": "0",
            "viewed_25_percent_cost": "0.69",
            "viewed_50_percent_cost": "0.93",
            "viewed_75_percent_cost": "1.14",
            "viewed_100_percent_cost": "1.29"
        },
        "carousel": {
            "slide_1_clicks": 0,
            "slide_1_shows": 0,
            "slide_2_clicks": 0,
            "slide_2_shows": 0,
            "slide_3_clicks": 0,
            "slide_3_shows": 0,
            "slide_4_clicks": 0,
            "slide_4_shows": 0,
            "slide_5_clicks": 0,
            "slide_5_shows": 0,
            "slide_6_clicks": 0,
            "slide_6_shows": 0,
            "slide_1_ctr": 0,
            "slide_2_ctr": 0,
            "slide_3_ctr": 0,
            "slide_4_ctr": 0,
            "slide_5_ctr": 0,
            "slide_6_ctr": 0
        },
        "playable": {
            "playable_game_open": 67,
            "playable_game_close": 75,
            "playable_call_to_action": 24
        },
        "tps": {
            "tps": "758.81",
            "tpd": "0"
        },
        "moat": {
            "impressions": 529459,
            "in_view": 91454,
            "never_focused": 7005,
            "never_visible": 410753,
            "never_50_perc_visible": 4658,
            "never_1_sec_visible": 15589,
            "human_impressions": 529973,
            "impressions_analyzed": 529973,
            "in_view_percent": 17.273104,
            "human_and_viewable_perc": 17.273104,
            "never_focused_percent": 1.3230486,
            "never_visible_percent": 77.57976,
            "never_50_perc_visible_percent": 0.8797659,
            "never_1_sec_visible_percent": 2.9443262,
            "in_view_diff_percent": -17.028236,
            "active_in_view_time": 0,
            "attention_quality": 0
        },
        "romi": {
            "value": "2479.5",
            "romi": 188.5152431929253,
            "adv_cost_share": 34.66021375277274
        },
        "custom_event": {
	    "custom_event_100": {
	        "alias": "",
		"count": 0
	    },
	    "custom_event_1116": {
		"alias": "Transition after reading the article",
		"count": 1497
	    }
        }
    },
    "limit": 20,
    "offset": 0,
    "count": 1
}

Statistics for the goals

GET {host}/api/v2/statistics/goals/{banners|campaigns|users}/day.json
The resource returns statistics on conversions Top@Mail.ru and mobile app installs for campaigns and banners in a resolution of 1 day.

Restrictions and filters are set using GET parameters:

ParameterFormatDescription
date_fromYYYY-MM-DDStart date;
date_toYYYY-MM-DDEnd date (inclusive)
idcomma-separated list of IDsA list of the IDs of the banners or campaigns
attributionimpressionTo attribute at the time of the event, time of show
conversion_typepostview; postclick; total; or combinations of them, separated by commasConversion type: postclick, postview, total

All parameters are required.

The structure of the response:

  • items- array of statistics for the requested period
    • id - object identifier
    • rows - array of statistics for a specific date
      • date - date
      • goals - arrays of statistics for goals
        • conversion_type - conversion type
        • source - event type: topmail-counter conversions, mobile-mobile conversions
        • goal - name of the counter goal or type for mobile (currently only install)
        • counter_id - the ID of the counter
        • count - number of conversions
        • cr - conversion rate
        • cpa - the cost of each conversion
        • value - the specified event value
        • romi - return on investment indicator
        • adv_cost_share - share of advertising expenses
    • total - total object statistics for the entire requested period
  • total - total statistics for all objects for the entire requested period

Example request:

{
    "items": [
        {
            "id": 1,
            "rows": [
                {
                    "date": "2017-03-13",
                    "goals": [
                        {
                            "conversion_type": "postclick",
                            "source": "topmail",
                            "goal": "my-goal",
                            "counter_id": 1,
                            "count": 0,
                            "cr": 0.0,
                            "cpa": "0.0",
                            "value": "0",
                            "romi": -100,
                            "adv_cost_share": 0
                        },
                        {
                            "conversion_type": "postclick",
                            "source": "mobile",
                            "goal": "install",
                            "counter_id": 0,
                            "count": 10,
                            "cr": 0.0,
                            "cpa": "0.0",
                            "value": "0",
                            "
romi
": -100,
                            "adv_cost_share": 0
                        },
                        {
                            "conversion_type": "postview",
                            "source": "mobile",
                            "goal": "install",
                            "counter_id": 0,
                            "count": 5,
                            "cr": 0.0,
                            "cpa": "0.0",
                            "value": "0",
                            "
romi
": -100,
                            "adv_cost_share": 0
                        },
                        {
                            "conversion_type": "total",
                            "source": "mobile",
                            "goal": "install",
                            "counter_id": 0,
                            "count": 15,
                            "cr": 0.0,
                            "cpa": "0.0",
                            "value": "0",
                            "
romi
": -100,
                            "adv_cost_share": 0
                        }
                    ]
                }
            ],
            "total": {
                "goals": [
                    {
                        "conversion_type": "postclick",
                        "source": "topmail",
                        "goal": "my-goal",
                        "counter_id": 1,
                        "count": 0,
                        "cr": 0.0,
                        "cpa": "0.0",
                        "value": "0",
                        "
romi
": -100,
                        "adv_cost_share": 0
                    },
                    {
                        "conversion_type": "postclick",
                        "source": "mobile",
                        "goal": "install",
                        "counter_id": 0,
                        "count": 10,
                        "cr": 0.0,
                        "cpa": "0.0",
                        "value": "0",
                        "romi": -100,
                        "adv_cost_share": 0
                    },
                    {
                        "conversion_type": "postview",
                        "source": "mobile",
                        "goal": "install",
                        "counter_id": 0,
                        "count": 5,
                        "cr": 0.0,
                        "cpa": "0.0",
                        "value": "0",
                        "romi": -100,
                        "adv_cost_share": 0
                    },
                    {
                        "conversion_type": "total",
                        "source": "mobile",
                        "goal": "install",
                        "counter_id": 0,
                        "count": 15,
                        "cr": 0.0,
                        "cpa": "0.0",
                        "value": "0",
                        "romi": -100,
                        "adv_cost_share": 0
                    }
                ]
            }
        }
    ],
    "total": {
        "goals": [
            {
                "conversion_type": "postclick",
                "source": "topmail",
                "goal": "my-goal",
                "counter_id": 1,
                "count": 0,
                "cr": 0.0,
                "cpa": "0.0",
                "value": "0",
                "romi": -100,
                "adv_cost_share": 0
            },
            {
                "conversion_type": "postclick",
                "source": "mobile",
                "goal": "install",
                "counter_id": 0,
                "count": 10,
                "cr": 0.0,
                "cpa": "0.0",
                "value": "0",
                "romi": -100,
                "adv_cost_share": 0
            },
            {
                "conversion_type": "postview",
                "source": "mobile",
                "goal": "install",
                "counter_id": 0,
                "count": 5,
                "cr": 0.0,
                "cpa": "0.0",
                "value": "0",
                "romi": -100,
                "adv_cost_share": 0
            },
            {
                "conversion_type": "total",
                "source": "mobile",
                "goal": "install",
                "counter_id": 0,
                "count": 15,
                "cr": 0.0,
                "cpa": "0.0",
                "value": "0",
                "romi": -100,
                "adv_cost_share": 0
            }
        ]
    }
}

Statistics for in-app events

GET {host}/api/v2/statistics/inapp/{banners|campaigns|users}/day.json

The resource returns statistics on mobile app events attributed to VK Ads ad impressions for campaigns and banners in a resolution of 1 day.

Restrictions and filters are set using GET parameters:

ParameterFormatDescription
date_fromYYYY-MM-DDStart date;
date_toYYYY-MM-DDEnd date (inclusive)
idcomma-separated list of IDsA list of the IDs of the banners or campaigns
attributionimpressionTo attribute at the time of the event, time of show
conversion_typepostview; postclick; total; or combinations of them, separated by commasConversion type: postclick, postview, total

All parameters are required.

The structure of the response:

  • items- array of statistics for the requested period
    • id - object identifier
    • rows - array of statistics for a specific date
      • date - date
      • inapps - arrays of statistical data on events
        • conversion_type - conversion type
        • cpa - the cost of each conversion
        • cr - conversion rate
        • count - number of conversions
        • event - the name of event
        • app - mobile app ID
        • tracker - mobile app tracker ID
        • value - the specified event value
        • romi - return on investment indicator
        • adv_cost_share - share of advertising expenses
    • total - total object statistics for the entire requested period
  • total - total statistics for all objects for the entire requested period

Example request:

{
  "total": {
    "inapps": [
      {
        "conversion_type": "postclick",
        "cpa": "256.17",
        "cr": 3.0446194225721785,
        "count": 58,
        "event": "af_add_to_cart",
        "app": 461,
        "tracker": 1,
        "value": 10.1,
        "romi": 1.1,
        "adv_cost_share": 0.5
      },
      {
        "conversion_type": "postclick",
        "cpa": "43.96",
        "cr": 17.74278215223097,
        "count": 338,
        "event": "af_content_view",
        "app": 461,
        "tracker": 1,
        "value": 10.1,
        "romi": 1.1,
        "adv_cost_share": 0.5
      },
      {
        "conversion_type": "postclick",
        "cpa": "4.84",
        "cr": 160.997375328084,
        "count": 3067,
        "event": "af_list_view",
        "app": 461,
        "tracker": 1,
        "value": 10.1,
        "romi": 1.1,
        "adv_cost_share": 0.5
      },
      {
        "conversion_type": "postclick",
        "cpa": "137.57",
        "cr": 5.669291338582677,
        "count": 108,
        "event": "af_view_cart",
        "app": 461,
        "tracker": 1,
        "value": 10.1,
        "romi": 1.1,
        "adv_cost_share": 0.5
      },
      {
        "conversion_type": "postclick",
        "cpa": "7428.97",
        "cr": 0.10498687664041995,
        "count": 6,
        "event": "af_purchase",
        "app": 461,
        "tracker": 1,
        "value": 10.1,
        "romi": 1.1,
        "adv_cost_share": 0.5
      },
      {
        "conversion_type": "postview",
        "cpa": "7428.97",
        "cr": 0.10498687664041995,
        "count": 4,
        "event": "af_purchase",
        "app": 461,
        "tracker": 1,
        "value": 10.1,
        "romi": 1.1,
        "adv_cost_share": 0.5
      },
      {
        "conversion_type": "total",
        "cpa": "7428.97",
        "cr": 0.10498687664041995,
        "count": 10,
        "event": "af_purchase",
        "app": 461,
        "tracker": 1,
        "value": 10.1,
        "romi": 1.1,
        "adv_cost_share": 0.5
      }
    ]
  },
  "items": [
    {
      "total": {
        "inapps": [
          {
            "conversion_type": "postclick",
            "cpa": "256.17",
            "cr": 3.0446194225721785,
            "count": 58,
            "event": "af_add_to_cart",
            "app": 461,
            "tracker": 1,
            "value": 10.1,
            "romi": 1.1,
            "adv_cost_share": 0.5
          },
          {
            "conversion_type": "postclick",
            "cpa": "43.96",
            "cr": 17.74278215223097,
            "count": 338,
            "event": "af_content_view",
            "app": 461,
            "tracker": 1,
            "value": 10.1,
            "romi": 1.1,
            "adv_cost_share": 0.5
          },
          {
            "conversion_type": "postclick",
            "cpa": "4.84",
            "cr": 160.997375328084,
            "count": 3067,
            "event": "af_list_view",
            "app": 461,
            "tracker": 1,
            "value": 10.1,
            "romi": 1.1,
            "adv_cost_share": 0.5
          },
          {
            "conversion_type": "postclick",
            "cpa": "137.57",
            "cr": 5.669291338582677,
            "count": 108,
            "event": "af_view_cart",
            "app": 461,
            "tracker": 1,
            "value": 10.1,
            "romi": 1.1,
            "adv_cost_share": 0.5
          },
          {
            "conversion_type": "postclick",
            "cpa": "7428.97",
            "cr": 0.10498687664041995,
            "count": 2,
            "event": "af_purchase",
            "app": 461,
            "tracker": 1,
            "value": 10.1,
            "romi": 1.1,
            "adv_cost_share": 0.5
          },
          {
            "conversion_type": "postview",
            "cpa": "7428.97",
            "cr": 0.10498687664041995,
            "count": 4,
            "event": "af_purchase",
            "app": 461,
            "tracker": 1,
            "value": 10.1,
            "romi": 1.1,
            "adv_cost_share": 0.5
          },
          {
            "conversion_type": "total",
            "cpa": "7428.97",
            "cr": 0.10498687664041995,
            "count": 10,
            "event": "af_purchase",
            "app": 461,
            "tracker": 1,
            "value": 10.1,
            "romi": 1.1,
            "adv_cost_share": 0.5
          }
        ]
      },
      "rows": [
        {
          "inapps": [],
          "date": "2017-11-21"
        },
        {
          "inapps": [],
          "date": "2017-11-22"
        },
        {
          "inapps": [
            {
              "conversion_type": "postclick",
              "cpa": "124.89",
              "cr": 7.785888077858881,
              "count": 32,
              "event": "af_add_to_cart",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postclick",
              "cpa": "23.51",
              "cr": 41.3625304136253,
              "count": 170,
              "event": "af_content_view",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postclick",
              "cpa": "2.26",
              "cr": 430.17031630170317,
              "count": 1768,
              "event": "af_list_view",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postclick",
              "cpa": "50.59",
              "cr": 19.22141119221411,
              "count": 79,
                "event": "af_view_cart",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            }
          ],
          "date": "2017-11-23"
        },
        {
          "inapps": [
            {
              "conversion_type": "postclick",
              "cpa": "153.79",
              "cr": 6.356968215158925,
              "count": 26,
              "event": "af_add_to_cart",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postclick",
              "cpa": "23.8",
              "cr": 41.075794621026894,
              "count": 168,
              "event": "af_content_view",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postclick",
              "cpa": "3.08",
              "cr": 317.6039119804401,
              "count": 1299,
              "event": "af_list_view",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postclick",
              "cpa": "1999.27",
              "cr": 0.4889975550122249,
              "count": 2,
              "event": "af_purchase",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postview",
              "cpa": "7428.97",
              "cr": 0.10498687664041995,
              "count": 4,
              "event": "af_purchase",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "total",
              "cpa": "7428.97",
              "cr": 0.10498687664041995,
              "count": 10,
              "event": "af_purchase",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            },
            {
              "conversion_type": "postclick",
              "cpa": "137.88",
              "cr": 7.090464547677261,
              "count": 29,
              "event": "af_view_cart",
              "app": 461,
              "tracker": 1,
              "value": 10.1,
              "romi": 1.1,
              "adv_cost_share": 0.5
            }
          ],
          "date": "2017-11-24"
        }
      ],
      "id": 24120913
    }
  ]
}

Offline convertions

The resource returns statistics on events attributed to VK Ads ad impressions from the lists of offline conversions for campaigns in the resolution of 1 day.

GET api/v2/statistics/offline_conversions/campaigns/day.json

ParameterFormatDescription
date_fromYYYY-MM-DDStart date;
date_toYYYY-MM-DDEnd date (inclusive)
idcomma-separated list of IDsList of campaign IDs


Date filters take into account the date of the event that the conversion is attributed to

Response parameters:

"rate" conversion rate = users who were converted and saw the ad/ all users who saw the ad
in percentage
"cost" actual cost of attraction = the cost of the campaign/  users who were converted and saw the ad
"offline" = number of conversions 

Fast statistics

GET {host}/api/v2/statistics/{faststat|uniquestat}/{banners|campaigns|users}.json

The resource returns basic statistics for advertising objects in real time, without filtering incorrect traffic. The values in the final statistics may differ significantly. 

Request uniquestat returns information about the unique coverage and its growth, but it works longer than faststat. Don't use uniquestat if you don't need information about unique coverage.

Restrictions and filters are set using GET parameters:

ParameterFormatDescription
idcomma-separated list of IDsA list of the IDs of the banners or campaigns

All parameters are required.

The structure of the response:

  • campaigns|banners|advertisers - array of statistics for the requested object
    • campaign_id|banner_id|user_id - array of statistics for a specific object
      • timestamp - time of the last registered event for this object
      • minutely|total - minute-by-minute|total arrays of object statistics. For a minute-by-minute array, the values for the last 60 minutes are returned in sub-arrays. The last element of each array with statistics corresponds to the time interval with the specified timestamp.
        • clicks - number of clicks;
        • shows - number of shows;
        • uniques (values only for uniquestat) - the number of unique users;
        • deltas (values only for uniquestat) - increase in unique users;
  • last_seen_msg_time - time (in different formats) when the last array of statistics was processed. 

Example request:

{
    last_seen_msg_time: {
        timestamp: 1550072300,
        string: "2019-02-13 18:38:20",
        ago: 5267        
    },
    banners: {},
    campaigns: {
        12121212: {
            timestamp: 1550071760,
            total: {
                clicks: [10311],
                shows: [72332],
                }                
            },
            minutely: {
                clicks: [140,
                92,
                176,
                275,
                237,
                151,
                192
                ],
                shows: [1253,
                ...,
                2331
                ],
                deltas: [...],
                                
            },
        21212121: {
            timestamp: 1550071333,
            total: {...},
            minutely: {...}
        }
    },
    advertisers: {}    
}