GetForecast

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

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 GetForecast (Live) version also exists for this method.

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

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 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)
         }
         ...
      ],
      "Common": {
         /* ForecastCommonInfo */
         "Geo": (string),
         "Min": (float),
         "Max": (float),
         "PremiumMin": (float)
         "Shows": (int),
         "Clicks": (int),
         "FirstPlaceClicks": (int),
         "PremiumClicks": (int),
      }
   }
}

Parameters are described below.


_{GetForecastInfo object}
^Parameter	^Description
`Phrases`	Array of BannerPhraseInfo objects. Each object contains a forecast for a single keyword that was specified when generating the report (CreateNewForecast 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, in Yandex units, for the lower block at the time when the forecast was made.
`Max`	Weighted average CPC, in Yandex units, for the top position in the lower block at the time when the forecast was made.
`PremiumMin`	Weighted average CPC, in Yandex units, for Premium Placement at the time when the forecast was made.
`PremiumMax`	Weighted average CPC, in Yandex units, for the top position in Premium Placement at the time when the forecast was made.
`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.
`PremiumClicks`	Possible 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`
_{ForecastCommonInfo object}
`Geo`	List of regions shown when generating a report (CreateNewForecast method).
`Min`	Cost of clicks in Yandex units when displayed in the lower block (other than the top position) for all specified keywords combined.
`Max`	Cost of clicks in Yandex units when displayed in the top position in the lower block for all specified keywords combined.
`PremiumMin`	Cost of clicks in Yandex units when displayed in Premium Placement for all specified keywords combined.
`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.


_{GetForecastInfo object}
^Parameter	^Description
`Phrases`	Array of BannerPhraseInfo objects. Each object contains a forecast for a single keyword that was specified when generating the report (CreateNewForecast 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, in Yandex units, for the lower block at the time when the forecast was made.
`Max`	Weighted average CPC, in Yandex units, for the top position in the lower block at the time when the forecast was made.
`PremiumMin`	Weighted average CPC, in Yandex units, for Premium Placement at the time when the forecast was made.
`PremiumMax`	Weighted average CPC, in Yandex units, for the top position in Premium Placement at the time when the forecast was made.
`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.
`PremiumClicks`	Possible 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`
_{ForecastCommonInfo object}
`Geo`	List of regions shown when generating a report (CreateNewForecast method).
`Min`	Cost of clicks in Yandex units when displayed in the lower block (other than the top position) for all specified keywords combined.
`Max`	Cost of clicks in Yandex units when displayed in the top position in the lower block for all specified keywords combined.
`PremiumMin`	Cost of clicks in Yandex units when displayed in Premium Placement for all specified keywords combined.
`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.

Was the article useful?

Please tell us what you didn't like about this article: