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.

Coverage Promotion Report

Info

Console

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

promotion — Product promotion
finance-and-accounting — View financial data and reports
all-methods — Full account management

Starts the generation of a summary report on the coverage promotion. What kind of report is this: for banners, for push notifications.

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 banners_statistics_report_consolidated)

CSV column name	JSON column name	XLSX column name	Value type
DATE	date	Дата	string
CAMPAIGN_TYPE	campaignType	Тип кампании	string
CAMPAIGN_ID	campaignId	ID кампании	integer
CAMPAIGN_NAME	campaignName	Название кампании	string
SHOWS	shows	Показы, шт.	integer
COVERAGE	coverage	Охват, чел.	integer
CLICKS	clicks	Клики, шт.	integer
CTR	ctr	CTR, %	number
SHOWS_FREQUENCY	showsFrequency	Частота показа	number
WATCHED_VIDEO_25	watchedVideo25	Просмотры 25%	number
WATCHED_VIDEO_50	watchedVideo50	Просмотры 50%	number
WATCHED_VIDEO_75	watchedVideo75	Просмотры 75%	number
WATCHED_VIDEO_100	watchedVideo100	Просмотры 100%	number
VTR_25	vtr25	VTR 25%	number
VTR_50	vtr50	VTR 50%	number
VTR_75	vtr75	VTR 75%	number
VTR_100	vtr100	VTR 100%	number
TURN_ON_VOLUME	turnOnVolume	Включения звука	integer
TURN_OFF_VOLUME	turnOffVolume	Выключения звука	integer
CART_ADDICTION	cartAddiction	Добавления в корзину, шт.	integer
ORDERED_COUNT	orderedCount	Заказанные товары, шт.	integer
CONVERSION	conversion	Конверсия в заказы, %	number
ORDERED_AMOUNT	orderedAmount	Стоимость заказанных товаров, ₽	number
CPO	cpo	СРО, ₽	number
COST	cost	Расчётные расходы, ₽	number
CPM	cpm	CPM, ₽	number
CPV	cpv	CPV, ₽	number
REAL_COST	realCost	Фактические расходы (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
DRR	drr	Доля расчётных расходов от выручки с баннером, %	number

Sheet Таргетинг по площадкам (file banners_statistics_report_by_service_type)

CSV column name	JSON column name	XLSX column name	Value type
DATE	date	Дата	string
CAMPAIGN_TYPE	campaignType	Тип кампании	string
CAMPAIGN_ID	campaignId	ID кампании	integer
CAMPAIGN_NAME	campaignName	Название кампании	string
SERVICE_TYPE	serviceType	Площадка	string
SHOWS	shows	Показы, шт.	integer
COVERAGE	coverage	Охват, чел.	integer
CLICKS	clicks	Клики, шт.	integer
CTR	ctr	CTR, %	number
SHOWS_FREQUENCY	showsFrequency	Частота показа	number
WATCHED_VIDEO_25	watchedVideo25	Просмотры 25%	number
WATCHED_VIDEO_50	watchedVideo50	Просмотры 50%	number
WATCHED_VIDEO_75	watchedVideo75	Просмотры 75%	number
WATCHED_VIDEO_100	watchedVideo100	Просмотры 100%	number
VTR_25	vtr25	VTR 25%	number
VTR_50	vtr50	VTR 50%	number
VTR_75	vtr75	VTR 75%	number
VTR_100	vtr100	VTR 100%	number
TURN_ON_VOLUME	turnOnVolume	Включения звука	integer
TURN_OFF_VOLUME	turnOffVolume	Выключения звука	integer
CART_ADDICTION	cartAddiction	Добавления в корзину, шт.	integer
ORDERED_COUNT	orderedCount	Заказанные товары, шт.	integer
CONVERSION	conversion	Конверсия в заказы, %	number
ORDERED_AMOUNT	orderedAmount	Стоимость заказанных товаров, ₽	number
CPO	cpo	СРО, ₽	number
COST	cost	Расчётные расходы, ₽	number
CPM	cpm	CPM, ₽	number
CPV	cpv	CPV, ₽	number
DRR	drr	Доля расчётных расходов от выручки с баннером, %	number

Sheet Данные по срезам (file banners_statistics_report_by_slices)

CSV column name	JSON column name	XLSX column name	Value type
DATE	date	Дата	string
CAMPAIGN_TYPE	campaignType	Тип кампании	string
CAMPAIGN_ID	campaignId	ID кампании	integer
CAMPAIGN_NAME	campaignName	Название кампании	string
SERVICE_TYPE	serviceType	Площадка	string
CREATIVE_FORMAT	creativeFormat	Формат	string
POSITION_NUMBER	positionNumber	Номер варианта	string
CREATIVE_HASH	creativeHash	Id варианта	string
CREATIVE_URL	creativeUrl	Ссылка на креатив	string
COPYRIGHT	copyright	Копирайт	string
SHOWS	shows	Показы, шт.	integer
COVERAGE	coverage	Охват, чел.	integer
CLICKS	clicks	Клики, шт.	integer
CTR	ctr	CTR, %	number
SHOWS_FREQUENCY	showsFrequency	Частота показа	number
WATCHED_VIDEO_25	watchedVideo25	Просмотры 25%	number
WATCHED_VIDEO_50	watchedVideo50	Просмотры 50%	number
WATCHED_VIDEO_75	watchedVideo75	Просмотры 75%	number
WATCHED_VIDEO_100	watchedVideo100	Просмотры 100%	number
VTR_25	vtr25	VTR 25%	number
VTR_50	vtr50	VTR 50%	number
VTR_75	vtr75	VTR 75%	number
VTR_100	vtr100	VTR 100%	number
TURN_ON_VOLUME	turnOnVolume	Включения звука	integer
TURN_OFF_VOLUME	turnOffVolume	Выключения звука	integer
CART_ADDICTION	cartAddiction	Добавления в корзину, шт.	integer
ORDERED_COUNT	orderedCount	Заказанные товары, шт.	integer
CONVERSION	conversion	Конверсия в заказы, %	number
ORDERED_AMOUNT	orderedAmount	Стоимость заказанных товаров, ₽	number
CPO	cpo	СРО, ₽	number
COST	cost	Расчётные расходы, ₽	number
CPM	cpm	CPM, ₽	number
CPV	cpv	CPV, ₽	number
DRR	drr	Доля расчётных расходов от выручки с кампании, %	number

⚙️ Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/reports/banners-statistics/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"
}

Name	Description
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",
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

estimatedGenerationTime

Type: integer

Expected generation time in milliseconds.

reportId

Type: string

The ID that will be needed to track the generation status and receive the finished report or document.

Example: example

The ID that will be needed to track the generation status and receive the finished report or document.

Example

{
  "reportId": "example",
  "estimatedGenerationTime": 0
}

Example

{
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Was the article helpful?

Shelf Report

Getting a given report or document