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 be changed.

Impression Boost 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 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 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/reports/shows-boost/generate

Query parameters

Name

Description

format

Type: ReportFormatType

The format of the report or document.

ReportFormatType

Report format:

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

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

{
    "businessId": 0,
    "dateFrom": "string",
    "dateTo": "string",
    "attributionType": "CLICKS"
}

Name	Description
attributionType*	Type: StatisticsAttributionType The type of attribution. Enum: `CLICKS`, `SHOWS`
businessId*	Type: integer<int64> Cabinet ID.
dateFrom*	Type: string<date> The beginning of the period, inclusive.
dateTo*	Type: string<date> End of the period, inclusive.

StatisticsAttributionType

Attribution type:

CLICKS — by clicks.
SHOWS — according to the 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.

Type	Description
StatisticsAttributionType	Enum: `CLICKS`, `SHOWS`

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": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

result

Type: GenerateReportDTO

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

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GenerateReportDTO

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

Name

Description

estimatedGenerationTime*

Type: integer<int64>

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.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Sales Analytics Report

Sales Boost Report