GetForecast (Live)

Returns the generated forecast for impressions, clicks and expenses by its ID.

For information about using the report, see the section Подбор ставок.

New in the Live 4 version

Added the Currency output parameter.

Added the AuctionBids output parameter.

Input data

The input data structure in JSON is shown below.

{
   "method": "GetForecast",
   "param": (int)
}

The param parameter specifies the ID that was obtained from the response to the CreateNewForecast (Live) method. You can also get the ID using the GetForecastList method.

Output data

The output data structure in JSON is shown below.

{
   "data": {
      /* GetForecastInfo */
      "Phrases": [
         {  /* BannerPhraseInfo */
            "Phrase": (string),
            "IsRubric": (string),
            "Min": (float),
            "Max": (float),
            "PremiumMin": (float),
            "PremiumMax": (float),
            "Shows": (int),
            "Clicks": (int),
            "FirstPlaceClicks": (int),
            "PremiumClicks": (int),
            "CTR": (float),
            "FirstPlaceCTR": (float),
            "PremiumCTR": (float),
            "Currency": (string),
            "AuctionBids": [
               {  /* PhraseAuctionBids */ 
                  "Position": (string),
                  "Bid": (float), 
                  "Price": (float)
               }
               ...
            ]
         }
         ...
      ],
      "Common": {
         /* ForecastCommonInfo */
         "Geo": (string),
         "Min": (float),
         "Max": (float),
         "PremiumMin": (float)
         "Shows": (int),
         "Clicks": (int),
         "FirstPlaceClicks": (int),
         "PremiumClicks": (int),
      }
   }
}

Parameters are described below.

ParameterDescription
GetForecastInfo object
Phrases

Array of BannerPhraseInfo objects. Each object contains a forecast for a single keyword that was specified when generating the report (CreateNewForecast (Live) method).

Common

The ForecastCommonInfo object with a cumulative forecast for all keywords.

BannerPhraseInfo object
Phrase

The keyword phrase that the forecast was generated for.

IsRubric

Whether the keyword is a Yandex.Catalog category. Always contains the value No.

Min

Weighted average CPC for the lower block at the time when the forecast was made.

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

Max

Weighted average CPC for the top position in the lower block at the time when the forecast was made.

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

PremiumMin

Weighted average CPC for Premium Placement at the time when the forecast was made.

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

PremiumMax

Weighted average CPC for the top position in Premium Placement at the time when the forecast was made.

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

Shows

Possible number of impressions for this keyword over the past month.

Clicks

Possible number of clicks on an ad in the lower block (other than the top position) over the past month.

FirstPlaceClicks

Possible number of clicks on an ad in the top position in the lower block over the past month.

PremiumClicksPossible number of clicks on an ad in Premium Placement over the past month.
CTR

CTR when displayed in the lower block, as a percentage. Calculated using the formula:

Clicks/Shows * 100

FirstPlaceCTR

CTR when displayed in the top position in the lower block. Calculated using the formula:

FirstPlaceClicks/Shows * 100

PremiumCTR

CTR when displayed in Premium Placement. Calculated using the formula:

PremiumClicks/Shows * 100

Currency

The currency that is used for CPCs and total expenditures in the report.

Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

AuctionBidsArray of PhraseAuctionBids objects containing auction results for the keyword: the bid for each position in Premium Placement and in the lower block, along with the actual CPC for each position.
PhraseAuctionBids object
PositionDisplay position: Pmn, where
  • m is the block number (1 is Premium Placement, 2 is Guaranteed Placement).
  • n is the position number within the block.

For example, P12 is the second position in Premium Placement, and P21 is the top position in Guaranteed Placement.

Bid

Minimum bid for the specified position (in the currency set in the Currency parameter).

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

Price

Actual CPC for the specified position (in the currency set in the Currency parameter).

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

ForecastCommonInfo object
Geo

List of regions shown when generating a report (CreateNewForecast (Live) method).

Min

Cost of clicks when displayed in the lower block (other than the top position) for all specified keywords combined (in the currency specified in the Currency parameter).

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

Max

Cost of clicks when displayed in the top position in the lower block for all specified keywords combined (in the currency specified in the Currency parameter).

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

PremiumMin

Cost of clicks when displayed in Premium Placement for all specified keywords combined (in the currency specified in the Currency parameter).

The value is converted to the currency specified in the Currency parameter and rounded up to the nearest bid increment in this currency.

Shows

Possible number of impressions for all keywords combined.

Clicks

Possible number of clicks in the lower block (other than the top position) for all specified keywords combined.

FirstPlaceClicks

Possible number of clicks in the top position in the lower block for all specified keywords combined.

PremiumClicks

Possible number of clicks in Premium Placement for all specified keywords combined.