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