Developers » API methods » Ads API » ads.getStatistics
Ads APIads.getStatistics
Returns statistics of performance indicators for ads, campaigns, clients or the whole account.
This method can be called with a user token. Access rights required: ads.
Parameters
account_idAdvertising account ID.
required parameter, int (number)
ids_typeType of requested objects listed in ids parameter:
  • ad ads;
  • campaign campaigns;
  • client clients;
  • office account.
required parameter, string
idsIDs requested ads, campaigns, clients or account, separated with a comma, depending on the value set in ids_type. Maximum 2000 objects.
required parameter, string
periodData grouping by dates:
  • day statistics by days;
  • month statistics by months;
  • overall overall statistics.
date_from and date_to parameters set temporary limits.
required parameter, string
date_fromDate to show statistics from. For different value of period different date format is used:
  • day: YYYY-MM-DD, example: 2011-09-27 September 27, 2011
    • 0 day it was created on;
  • month: YYYY-MM, example: 2011-09 September 2011
    • 0 month it was created in;
  • overall: 0.
required parameter, string
date_toDate to show statistics to. For different value of period different date format is used:
  • day: YYYY-MM-DD, example: 2011-09-27 September 27, 2011
    • 0 current day;
  • month: YYYY-MM, example: 2011-09 September 2011
    • 0 current month;
  • overall: 0.
required parameter, string
stats_fields
list of comma-separated words
Result
Each requested object contains the following fields:
  • id object ID from ids parameter;
  • type object ID from ids_type parameter;
  • stats list of structures that describe object statistics over one period of time (specific period is listed if any statistics can be applied to it).

Structure in stats list has the following fields:
    • day (if period is day) one day, in YYYY-MM-DD format;
    • month (if 'period is month) one month, in YYYY-MM format;
    • overall (if period is overall) 1;
    • spent spent funds;
    • impressions impressions;
    • clicks clicks;
    • reach (if ids_type is ad or campaign and period is day or month) reach;
    • video_views (if ids_type is ad) video views (for video ads);
    • video_views_half (if ids_type is ad) half-video views (for video ads);
    • video_views_full (if ids_type is ad) full-video views (for video ads);
    • video_clicks_site (if ids_type is ad) visits of advertiser's website from the video ad (for video ads);
    • join_rate (if ids_type is ad or campaign) number of joins to a group, event, subscriptions for a public page or application installation (only if the ad includes a direct link to the respective VK page).
    • uniq_views_count unique views
    • ctr CTR
    • effective_cost_per_click eCPC
    • effective_cost_per_mille eCPM
    • effective_cpf eCPF
  • Messages
    • effective_cost_per_message message cost
    • message_sends messages amount
  • Videos
    • video_plays_unique_started the number of users who played the video
    • video_plays_unique_3_seconds the number of users who watched 3 seconds of the video
    • video_plays_unique_25_percents the number of users who watched 25% of the video
    • video_plays_unique_50_percents the number of users who watched 60% of the video
    • video_plays_unique_75_percents the number of users who watched 75% of the video
    • video_plays_unique_100_percents the number of users who watched 100% of the video
  • Conversions
    • conversion_count conversion count
    • conversion_sum conversion sum (from version 5.122 contains value in rubles)
    • conversion_roas conversion roas
    • conversion_cr conversion cr

Errors
601Permission denied. You have requested too many actions this day. Try later.
Global errors can occur while running. See their descriptions on this page.
Version historyShow all
5.105
The goals field was removed from the response from ads.getStatistics. The lead_form_sends field is returned instead.

In apps.getActivity, a new media object was added for the achievement type, which contains images for the achievement under the images key. If there are no images, then the media field would be absent.

Two new fields were added for the apps.get method and the app object: mobile_controls_type and mobile_view_support_type, which describe how control elements of games are displayed in webview on native clients.

mobile_controls_type = 0 transparent control element overlay on the game view;
mobile_controls_type = 1 black line above the game view;
mobile_controls_type = 2 no controls, only for VK apps.

mobile_view_support_type = 0 the game doesnt use the bottom part of the iPhone X screen, the black line is present.
mobile_view_support_type = 1 the game uses the bottom part of the iPhone X screen, the black line is absent.
Affects methods apps.get, ads.getStatistics