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

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

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

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

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

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

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

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

Request

POST

https://api.partner.market.yandex.ru/reports/banners-statistics/generate

Query parameters

Name

Description

format

Type: ReportFormatType

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

ReportFormatType

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

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

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

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

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

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

Enum: OK, ERROR

GenerateReportDTO

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

Name

Description

estimatedGenerationTime*

Type: integer<int64>

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

reportId*

Type: string

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

400 Bad Request

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

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

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

403 Forbidden

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

420 Method Failure

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

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

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