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.
Sales 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
- 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 sales boost for the specified period. What is a sales boost?
The report contains information on all campaigns created both through the API and in the dashboard.
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_boost_consolidated)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
SHOP_SKU |
shopSku |
Ваш SKU |
string |
|
OFFER_NAME |
offerName |
Название товара |
string |
|
SHOWS_WITH_FEE |
showsWithFee |
Показы товара с бустом, шт. |
integer |
|
SHOWS |
shows |
Все показы товара, шт. |
integer |
|
CLICKS_VENDOR_WITH_FEE |
clicksVendorWithFee |
Клики по товару с бустом, шт. |
integer |
|
CLICKS_VENDOR |
clicksVendor |
Все клики по товару, шт. |
integer |
|
CLICKS_CPA_WITH_FEE |
clicksCpaWithFee |
Добавления в корзину товаров с бустом, шт. |
integer |
|
CLICKS_CPA |
clicksCpa |
Все добавления товаров в корзину, шт. |
integer |
|
ORDER_ITEMS_WITH_FEE |
orderItemsWithFee |
Заказанные товары с бустом, шт. |
integer |
|
ORDER_ITEMS |
orderItems |
Все заказанные товары, шт. |
integer |
|
ORDER_ITEMS_DELIVERED_WITH_FEE |
orderItemsDeliveredWithFee |
Доставленные товары с бустом, шт. |
integer |
|
ORDER_ITEMS_DELIVERED |
orderItemsDelivered |
Всего доставлено товаров, шт. |
integer |
|
DEDUCTED_BONUSES |
deductedBonuses |
Списано бонусов |
number |
|
COST_REVENUE_RATIO |
costRevenueRatio |
Доля расходов на буст от выручки с бустом, % |
number |
|
REVENUE_SHARE |
revenueShare |
Доля выручки с бустом от всей выручки, % |
number |
|
SALES_CAMPAIGN_IDS |
salesCampaignIds |
ID кампаний |
string |
|
SALES_CAMPAIGN_NAMES |
salesCampaignNames |
Названия кампаний |
string |
|
BILLED_AMOUNT |
billedAmount |
Расходы на буст,.* |
number |
|
AVERAGE_BOOST_COST |
averageBoostCost |
Средняя стоимость буста,.* |
number |
|
ORDERS_GVM_DELIVERED_WITH_FEE |
ordersGvmDeliveredWithFee |
Выручка с бустом,.* |
number |
|
ORDERS_GVM_DELIVERED |
ordersGvmDelivered |
Вся выручка,.* |
number |
| ⚙️ Limit: 100 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/boost-consolidated/generate
Query parameters
|
Name |
Description |
|
format |
Type: string The format of the report or document. Report format:
Default: Enum: |
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: |
|
dateFrom |
Type: string<date> The beginning of the period, inclusive. Date format: Example: |
|
dateTo |
Type: string<date> End of the period, inclusive. Date format: Example: |
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 in Yandex. 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"
}
schema:
description: |
The data required to generate the report.
type: object
required:
- businessId
- dateFrom
- dateTo
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'
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/boost-consolidated/generate
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.