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 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 |
| , Limit: 100 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/reports/boost-consolidated/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 |
|
Default: Enum: |
Body
application/json
{
"businessId": 0,
"dateFrom": "string",
"dateTo": "string"
}
|
Name |
Description |
|
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. |
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:
Enum: |
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 |
|
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error of the 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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.