Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

Отчет по бусту показов

Метод доступен для всех моделей.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Запускает генерацию сводного отчета по бусту показов за заданный период. Что такое буст показов

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса 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

Формат отчета или документа.

Формат отчета:

  • FILE — файл с электронной таблицей (XLSX).
  • CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
  • JSON — ZIP-архив с JSON-файлами на каждый лист отчета.

Default: FILE

Enum: FILE, CSV, JSON

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

Тип атрибуции.

Тип атрибуции:

  • CLICKS — по кликам.
  • SHOWS — по показам.

О том, какие данные в отчете зависят и не зависят от типа атрибуции, читайте в Справке Маркета для продавцов.

Enum: CLICKS, SHOWS

businessId

Type: BusinessId

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Example: 1

dateFrom

Type: PeriodDateFrom

Начало периода, включительно.

Формат даты: ГГГГ-ММ-ДД.

Example: 2025-08-22

dateTo

Type: PeriodDateTo

Конец периода, включительно.

Формат даты: ГГГГ-ММ-ДД.

Example: 2025-09-22

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"
}

Type: object

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Example
{
  "status": "OK"
}

GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

Name

Description

estimatedGenerationTime

Type: integer

Ожидаемая продолжительность генерации в миллисекундах.

reportId

Type: string

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

Example: example
Example
{
  "reportId": "example",
  "estimatedGenerationTime": 0
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
  "status": "OK"
}

Type: object

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: 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: 1

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

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams: []
searchParams:
  - description: Формат отчета или документа.
    name: format
    in: query
    required: false
    schema:
      $ref: >-
        /home/sandbox/.ya/build/build_root/l6go/00000b/market/mbi/docs/partner-api/docfiles/__docsbuild/.tmp_input/ru/openapi/partner-api-spec/reports/schemas.yaml#/ReportFormatType
headers: []
body: |-
  {
    "businessId": 1,
    "dateFrom": "2025-08-22",
    "dateTo": "2025-09-22",
    "attributionType": "CLICKS"
  }
schema:
  description: |
    Данные, необходимые для генерации отчета.
  type: object
  required:
    - businessId
    - dateFrom
    - dateTo
    - attributionType
  properties:
    businessId:
      description: "Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)\n"
      type: integer
      format: int64
      minimum: 1
    dateFrom:
      type: string
      format: date
      description: |
        Начало периода, включительно.

        Формат даты: `ГГГГ-ММ-ДД`.
      example: '2025-08-22'
    dateTo:
      type: string
      format: date
      description: |
        Конец периода, включительно.

        Формат даты: `ГГГГ-ММ-ДД`.
      example: '2025-09-22'
    attributionType:
      description: Тип атрибуции.
      $ref: '#/$defs/StatisticsAttributionType'
  $defs:
    /home/sandbox/.ya/build/build_root/l6go/00000b/market/mbi/docs/partner-api/docfiles/__docsbuild/.tmp_input/ru/openapi/partner-api-spec/reports/schemas.yaml#/StatisticsAttributionType:
      type: string
      description: >
        Тип атрибуции:
          * `CLICKS` — по кликам.
          * `SHOWS` — по показам.
        <br><br>


        О том, какие данные в отчете зависят и не зависят от типа атрибуции,
        читайте [в Справке Маркета для
        продавцов](https://yandex.ru/support2/marketplace/ru/marketing/shelf#stats).
      enum:
        - CLICKS
        - SHOWS
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/shows-boost/generate
host: https://api.partner.market.yandex.ru

No longer supported, please use an alternative and newer version.

Предыдущая
Отчет по схождению с закрывающими документами
Следующая
Отчет по бусту продаж