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

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

Отчет по охватному продвижению

Метод доступен для моделей: FBY, FBS, Экспресс и DBS.

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

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

Запускает генерацию сводного отчета по охватному продвижению. Что это за отчет: для баннеров, для пуш-уведомлений.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET v2/reports/info/{reportId}.

Пояснение к колонкам отчета:

Лист Общий отчет (файл banners_statistics_report_consolidated)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

DATE

date

Дата

string

CAMPAIGN_TYPE

campaignType

Тип кампании

string

CAMPAIGN_ID

campaignId

ID кампании

integer

CAMPAIGN_NAME

campaignName

Название кампании

string

SHOWS

shows

Показы, шт.

integer

COVERAGE

coverage

Охват, чел.

integer

CLICKS

clicks

Клики, шт.

integer

CTR

ctr

CTR, %

number

SHOWS_FREQUENCY

showsFrequency

Частота показа

number

WATCHED_VIDEO_25

watchedVideo25

Просмотры 25%

number

WATCHED_VIDEO_50

watchedVideo50

Просмотры 50%

number

WATCHED_VIDEO_75

watchedVideo75

Просмотры 75%

number

WATCHED_VIDEO_100

watchedVideo100

Просмотры 100%

number

VTR_25

vtr25

VTR 25%

number

VTR_50

vtr50

VTR 50%

number

VTR_75

vtr75

VTR 75%

number

VTR_100

vtr100

VTR 100%

number

TURN_ON_VOLUME

turnOnVolume

Включения звука

integer

TURN_OFF_VOLUME

turnOffVolume

Выключения звука

integer

CART_ADDICTION

cartAddiction

Добавления в корзину, шт.

integer

ORDERED_COUNT

orderedCount

Заказанные товары, шт.

integer

CONVERSION

conversion

Конверсия в заказы, %

number

ORDERED_AMOUNT

orderedAmount

Стоимость заказанных товаров, ₽

number

CPO

cpo

СРО, ₽

number

COST

cost

Расчётные расходы, ₽

number

CPM

cpm

CPM, ₽

number

CPV

cpv

CPV, ₽

number

REAL_COST

realCost

Фактические расходы (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

DRR

drr

Доля расчётных расходов от выручки с баннером, %

number
Лист Таргетинг по площадкам (файл banners_statistics_report_by_service_type)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

DATE

date

Дата

string

CAMPAIGN_TYPE

campaignType

Тип кампании

string

CAMPAIGN_ID

campaignId

ID кампании

integer

CAMPAIGN_NAME

campaignName

Название кампании

string

SERVICE_TYPE

serviceType

Площадка

string

SHOWS

shows

Показы, шт.

integer

COVERAGE

coverage

Охват, чел.

integer

CLICKS

clicks

Клики, шт.

integer

CTR

ctr

CTR, %

number

SHOWS_FREQUENCY

showsFrequency

Частота показа

number

WATCHED_VIDEO_25

watchedVideo25

Просмотры 25%

number

WATCHED_VIDEO_50

watchedVideo50

Просмотры 50%

number

WATCHED_VIDEO_75

watchedVideo75

Просмотры 75%

number

WATCHED_VIDEO_100

watchedVideo100

Просмотры 100%

number

VTR_25

vtr25

VTR 25%

number

VTR_50

vtr50

VTR 50%

number

VTR_75

vtr75

VTR 75%

number

VTR_100

vtr100

VTR 100%

number

TURN_ON_VOLUME

turnOnVolume

Включения звука

integer

TURN_OFF_VOLUME

turnOffVolume

Выключения звука

integer

CART_ADDICTION

cartAddiction

Добавления в корзину, шт.

integer

ORDERED_COUNT

orderedCount

Заказанные товары, шт.

integer

CONVERSION

conversion

Конверсия в заказы, %

number

ORDERED_AMOUNT

orderedAmount

Стоимость заказанных товаров, ₽

number

CPO

cpo

СРО, ₽

number

COST

cost

Расчётные расходы, ₽

number

CPM

cpm

CPM, ₽

number

CPV

cpv

CPV, ₽

number

DRR

drr

Доля расчётных расходов от выручки с баннером, %

number
Лист Данные по срезам (файл banners_statistics_report_by_slices)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

DATE

date

Дата

string

CAMPAIGN_TYPE

campaignType

Тип кампании

string

CAMPAIGN_ID

campaignId

ID кампании

integer

CAMPAIGN_NAME

campaignName

Название кампании

string

SERVICE_TYPE

serviceType

Площадка

string

CREATIVE_FORMAT

creativeFormat

Формат

string

POSITION_NUMBER

positionNumber

Номер варианта

string

CREATIVE_HASH

creativeHash

Id варианта

string

CREATIVE_URL

creativeUrl

Ссылка на креатив

string

COPYRIGHT

copyright

Копирайт

string

SHOWS

shows

Показы, шт.

integer

COVERAGE

coverage

Охват, чел.

integer

CLICKS

clicks

Клики, шт.

integer

CTR

ctr

CTR, %

number

SHOWS_FREQUENCY

showsFrequency

Частота показа

number

WATCHED_VIDEO_25

watchedVideo25

Просмотры 25%

number

WATCHED_VIDEO_50

watchedVideo50

Просмотры 50%

number

WATCHED_VIDEO_75

watchedVideo75

Просмотры 75%

number

WATCHED_VIDEO_100

watchedVideo100

Просмотры 100%

number

VTR_25

vtr25

VTR 25%

number

VTR_50

vtr50

VTR 50%

number

VTR_75

vtr75

VTR 75%

number

VTR_100

vtr100

VTR 100%

number

TURN_ON_VOLUME

turnOnVolume

Включения звука

integer

TURN_OFF_VOLUME

turnOffVolume

Выключения звука

integer

CART_ADDICTION

cartAddiction

Добавления в корзину, шт.

integer

ORDERED_COUNT

orderedCount

Заказанные товары, шт.

integer

CONVERSION

conversion

Конверсия в заказы, %

number

ORDERED_AMOUNT

orderedAmount

Стоимость заказанных товаров, ₽

number

CPO

cpo

СРО, ₽

number

COST

cost

Расчётные расходы, ₽

number

CPM

cpm

CPM, ₽

number

CPV

cpv

CPV, ₽

number

DRR

drr

Доля расчётных расходов от выручки с кампании, %

number
⚙️ Лимит: 100 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v2/reports/banners-statistics/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"
}

Name

Description

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

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

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

  • 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",
  "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: 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",
  "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.

Предыдущая
Отчет по полкам
Следующая
Получение заданного отчета или документа