The structure and content of the reports are subject to change without prior notice.

For example, a new column may be added or the name of the sheet may change.

Impression Boost Report

The method is available for all models.

Not yet available for Market Yandex Go sellers.

If you are using an API Key token, one of the accesses in the list is required to call the method

Starts the generation of a summary report on the boost of impressions for the specified period. What is a boost of impressions?

You can find out the generation status and get a link to the finished report using a request. GET v2/reports/info/{reportId}.

Explanation of the report columns:

Sheet Отчёт по кампаниям (file business_shows_boost_consolidated_campaigns)

CSV column name

JSON column name

XLSX column name

Value type

DATE

date

Дата

string

SALE_CAMPAIGN_ID

saleCampaignId

ID кампании

integer

SALE_CAMPAIGN_NAME

saleCampaignName

Название кампании

string

SHOWS

shows

Показы, шт.

integer

COVERAGE

coverage

Охват, чел.

integer

CLICKS

clicks

Клики, шт.

integer

CTR

ctr

CTR, %

number

SHOWS_FREQUENCY

showsFrequency

Частота показа

number

CART_ADDITION

cartAddition

Добавления в корзину, шт.

integer

ORDERED_COUNT

orderedCount

Заказанные товары, шт.

integer

CONVERSION

conversion

Конверсия в заказы, %

number

ORDERED_AMOUNT

orderedAmount

Стоимость заказанных товаров, ₽

number

CPO

cpo

СРО, ₽

number

COST

cost

Расчётные расходы, ₽

number

COST_SHARE

costShare

Доля расчетных расходов от выручки с бустом продаж с оплатой за показы

number

CPM

cpm

CPM, ₽

number

REAL_COST

realCost

Фактические расходы, ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number
Sheet Отчёт по товарам (file business_shows_boost_consolidated_offers)

CSV column name

JSON column name

XLSX column name

Value type

OFFER_ID

offerId

Ваш SKU

string

OFFER_NAME

offerName

Название товара

string

SHOWS

shows

Показы товаров с бустом продаж с оплатой за показы

integer

CLICKS

clicks

Клики по товарам с бустом продаж с оплатой за показы

integer

CART_ADDITION

cartAddition

Добавления в корзину с бустом продаж с оплатой за показы

integer

ORDERED_COUNT

orderedCount

Заказанные товары с бустом продаж с оплатой за показы

integer

CPM

cpm

CPM

number

COST

cost

Расчётные расходы на буст продаж с оплатой за показы, ₽

number

ORDERED_AMOUNT

orderedAmount

Выручка с бустом продаж с оплатой за показы

number

SALES_CAMPAIGN_IDS

salesCampaignIds

ID кампаний

string

SALES_CAMPAIGN_NAMES

salesCampaignNames

Названия кампаний

string
⚙️ Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/reports/shows-boost/generate

Query parameters

Name

Description

format

Type: string

The format of the report or document. Report format:

  • FILE — the spreadsheet file (XLSX).
  • CSV — A ZIP archive with CSV files for each report sheet.
  • JSON — A ZIP archive with JSON files for each report sheet.

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
  "businessId": 1,
  "dateFrom": "2025-08-22",
  "dateTo": "2025-09-22",
  "attributionType": "CLICKS"
}

Name

Description

attributionType

Type: string

Attribution type:

  • CLICKS — by clicks.
  • SHOWS — by impressions.

For information about which data in the report depends and does not depend on the type of attribution, read in the Help of the Market for sellers.

Enum: CLICKS, SHOWS

businessId

Type: integer

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

dateFrom

Type: string<date>

The beginning of the period, inclusive.

Date format: YYYY-MM-DD.

Example: 2025-08-22

dateTo

Type: string<date>

End of the period, inclusive.

Date format: YYYY-MM-DD.

Example: 2025-09-22

Responses

200 OK

In response, you receive an identifier that allows you to find out the generation status and download the finished report.

Body

application/json
{
  "status": "OK"
}

Type: object

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams: []
searchParams:
  - description: The format of the report or document.
    name: format
    in: query
    required: false
    schema:
      description: >
        Report format:


        * `FILE` — the spreadsheet file
        (XLSX).

        * `CSV` — A ZIP archive with CSV files for
        each report sheet.

        * `JSON` — A ZIP archive with JSON files
        for each report sheet.
      type: string
      enum:
        - FILE
        - CSV
        - JSON
      default: FILE
headers: []
body: |-
  {
    "businessId": 1,
    "dateFrom": "2025-08-22",
    "dateTo": "2025-09-22",
    "attributionType": "CLICKS"
  }
schema:
  description: |
    The data required to generate the report.
  type: object
  required:
    - businessId
    - dateFrom
    - dateTo
    - attributionType
  properties:
    businessId:
      description: "Cabinet ID. To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html)\n"
      type: integer
      format: int64
      minimum: 1
    dateFrom:
      type: string
      format: date
      description: |
        The beginning of the period, inclusive.

        Date format: `YYYY-MM-DD`.
      example: '2025-08-22'
    dateTo:
      type: string
      format: date
      description: |
        End of the period, inclusive.

        Date format: `YYYY-MM-DD`.
      example: '2025-09-22'
    attributionType:
      type: string
      description: >
        Attribution type:
          * `CLICKS` — by clicks.
          * `SHOWS` — by impressions.
        <br><br>


        For information about which data in the report depends and does not
        depend on the type of attribution, read [in the Help of the Market for
        sellers](https://yandex.ru/support2/marketplace/ru/marketing/shelf#stats).
      enum:
        - CLICKS
        - SHOWS
bodyType: application/json
method: post
security:
  - type: apiKey
    name: 'Api-Key'
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/reports/shows-boost/generate
host: https://api.partner.market.yandex.ru

No longer supported, please use an alternative and newer version.

Previous
Report on convergence with closing documents
Next
Sales Boost Report