---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.com/dev/direct/doc/dg-v4/en/live/GetForecast.md
  - https://yandex.com/dev/direct/doc/dg-v4/ru/live/GetForecast.md
  - href: en/live/GetForecast.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/dg-v4/en/llms.txt

# GetForecast (Live)
Returns the generated forecast for impressions, clicks and expenses by its ID.
For information about using the report, see the section [Подбор ставок](https://yandex.com/dev/direct/doc/dg-v4/en/concepts/choice-rates.md).

## New in the Live 4 version

Added the Currency output parameter.

Added the AuctionBids output parameter.


## Input data {#input}

The input data structure in JSON is shown below.

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

The `param` parameter specifies the ID that was obtained from the response to the [CreateNewForecast (Live)](https://yandex.com/dev/direct/doc/dg-v4/en/live/CreateNewForecast.md) method. You can also get the ID using the [GetForecastList](https://yandex.com/dev/direct/doc/dg-v4/en/reference/GetForecastList.md) method.


## Output data {#output}

The output data structure in JSON is shown below.

```javascript
{
   "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.


#|
||
**<sup >Parameter</sup>**
|
**<sup >Description</sup>**
||

||
**<sub >GetForecastInfo object</sub>**
||
||
`Phrases`
|
Array of `BannerPhraseInfo` objects. Each object contains a forecast for a single keyword that was specified when generating the report ([CreateNewForecast (Live)](https://yandex.com/dev/direct/doc/dg-v4/en/live/CreateNewForecast.md) method).
||
||
`Common`
|
The `ForecastCommonInfo` object with a cumulative forecast for all keywords.
||

||
**<sub >BannerPhraseInfo object</sub>**
||
||
`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.
||
||
`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`
||
||
`Currency`
|
The currency that is used for CPCs and total expenditures in the report.

Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.
||
||
`AuctionBids`
|
Array 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.
||

||
**<sub >PhraseAuctionBids object</sub>**
||
||
`Position`
|
Display position: P_mn_, 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.
||

||
**<sub >ForecastCommonInfo object</sub>**
||
||
`Geo`
|
List of regions shown when generating a report ([CreateNewForecast (Live)](https://yandex.com/dev/direct/doc/dg-v4/en/live/CreateNewForecast.md) 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.
||
|#