GetSummaryStat

Returns statistics for the specified campaigns for each day of the specified period.

Attention.

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions 4 and 5, see the Migration guide.

The GetSummaryStat (Live) version also exists for this method.

Restrictions

Up to 100 method calls per day for a single campaign.

The number of requested campaigns multiplied by the number of days in the selected period must not exceed 1000.

Statistics are available for the three years prior to the current month. For example: on September 15, 2016, you can get data starting from September 1, 2013.

Input data

The input data structure in JSON is shown below.

{
   "method": "GetSummaryStat",
   "param": {
      /* GetSummaryStatRequest */
      "CampaignIDS": [
         (int)
         ...
      ],
      "StartDate": (date),
      "EndDate": (date)
   }
}

Parameters are described below.

ParameterDescriptionRequired
GetSummaryStatRequest object
CampaignIDS

Array containing campaign IDs.

Attention. The number of campaigns multiplied by the number of days in the report period must not exceed 1000.
Yes
StartDateThe start date of the report period that statistics are being returned for (YYYY-MM-DD).Yes
EndDateThe end date of the report period that statistics are being returned for (YYYY-MM-DD).Yes

Output data

The method returns an array of StatItem objects. Each object contains statistics for a single campaign for a single date in the selected period.

Attention. If the requested campaign did not have any impressions for the entire period, information about the campaign is not output in the response.

Part of the returned parameters are based on Yandex.Metrica data (see the Help section Yandex.Metrica: advertising campaign efficiency evaluation).

{
   "data": [
      {  /* StatItem */
         "CampaignID": (int),
         "StatDate": (date),
         "SumSearch": (float),
         "SumContext": (float),
         "ShowsSearch": (int),
         "ShowsContext": (int),
         "ClicksSearch": (int),
         "ClicksContext": (int),
         "SessionDepthSearch": (float),
         "SessionDepthContext": (float),
         "GoalConversionSearch": (float),
         "GoalConversionContext": (float),
         "GoalCostSearch": (float),
         "GoalCostContext": (float)
      }
      ...
   ]
}

Parameters are described below.

ParameterDescription
StatItem object
CampaignIDThe campaign ID.
StatDateThe data statistics are provided for.
SumSearchCost of clicks in the search.
SumContextCost of clicks in the Yandex Advertising Network.
ShowsSearchNumber of impressions in the search.
ShowsContextNumber of impressions in the Yandex Advertising Network.
ClicksSearchNumber of clicks in the search.
ClicksContextNumber of clicks in the Yandex Advertising Network.
SessionDepthSearch

Session depth for a site when clicking through from the search.

Taken from Yandex.Metrica data, and only if the CPAOptimizer automatic strategy is used on the search.

SessionDepthContext

Session depth for a site when clicking through from the Yandex Advertising Network.

Taken from Yandex.Metrica data, but only if the CPAOptimizer automatic strategy is used in the Yandex Advertising Network.

GoalConversionSearch

The percentage of goal visits as part of the total number of visits when transferring from Search.

Taken from Yandex.Metrica data, and only if the CPAOptimizer automatic strategy is used on the search.

GoalConversionContext

The percentage of goal visits as part of the total number of visits when transferring from the Yandex Advertising Network.

Taken from Yandex.Metrica data, but only if the CPAOptimizer automatic strategy is used in the Yandex Advertising Network.

GoalCostSearch

Cost of achieving a Yandex.Metrica goal for click-throughs from the search.

Taken from Yandex.Metrica data, and only if the CPAOptimizer automatic strategy is used on the search.

GoalCostContext

Cost of achieving a Yandex.Metrica goal for click-throughs from the Yandex Advertising Network.

Taken from Yandex.Metrica data, but only if the CPAOptimizer automatic strategy is used in the Yandex Advertising Network.

Examples of input data

Python

{
   'CampaignIDS': [238456],
   'StartDate': '2011-05-14',
   'EndDate': '2011-05-19'
}

PHP

array(
   'CampaignIDS' => array(238456),
   'StartDate' => '2011-05-14',
   'EndDate' => '2011-05-19'
)

Perl

{
   'CampaignIDS' => [238456],
   'StartDate' => '2011-05-14',
   'EndDate' => '2011-05-19'
}