Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
Отчет по бусту продаж
Метод доступен для всех моделей.
Пока недоступен для продавцов Market Yandex Go.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- promotion — Продвижение товаров
- finance-and-accounting — Просмотр финансовой информации и отчётности
- all-methods — Полное управление кабинетом
Запускает генерацию сводного отчета по бусту продаж за заданный период. Что такое буст продаж
Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
Пояснение к колонкам отчета:
Лист Сводный отчет (файл business_boost_consolidated)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
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 |
| ⚙️ Лимит: 100 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/reports/boost-consolidated/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType Формат отчета или документа. |
ReportFormatType
Формат отчета:
FILE— файл с электронной таблицей (XLSX).CSV— ZIP-архив с CSV-файлами на каждый лист отчета.JSON— ZIP-архив с JSON-файлами на каждый лист отчета.
|
Type |
Description |
|
Default: Enum: |
Body
application/json
{
"businessId": 0,
"dateFrom": "string",
"dateTo": "string"
}
|
Name |
Description |
|
businessId* |
Type: integer<int64> Идентификатор кабинета. |
|
dateFrom* |
Type: string<date> Начало периода, включительно. |
|
dateTo* |
Type: string<date> Конец периода, включительно. |
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
result |
Type: GenerateReportDTO Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.
|
Name |
Description |
|
estimatedGenerationTime* |
Type: integer<int64> Ожидаемая продолжительность генерации в миллисекундах. |
|
reportId* |
Type: string Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code* |
Type: string Код ошибки. |
|
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.