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

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

Отчет по счету маркетинга

Info

Console

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

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

finance-and-accounting — Просмотр финансовой информации и отчётности
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Запускает генерацию отчета по счету маркетинга.

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

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

Лист Полки (файл advertiser_operations_shelf)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Буст продаж, оплата за показы (файл advertiser_operations_cpm_boost)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Товарные баннеры (файл advertiser_operations_product_banners)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Буст продаж, оплата за продажи (файл advertiser_operations_cpa_auction_promotion)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Баннеры (бронирование) (файл advertiser_operations_package_banners)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Баннеры (аукцион) (файл advertiser_operations_auction_banners)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Баннеры кликаут (бронирование) (файл advertiser_operations_package_banners_clickout)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Баннеры кликаут (аукцион) (файл advertiser_operations_auction_banners_clickout)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Пуши (бронирование) (файл advertiser_operations_package_pushes)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Пуши (аукцион) (файл advertiser_operations_auction_pushes)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Поп-ап уведомления (бронирование) (файл advertiser_operations_package_popups)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Поп-ап уведомления (аукцион) (файл advertiser_operations_auction_popups)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Полки с оплатой по дням (файл advertiser_operations_cpd_promotion)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
CAMPAIGN_NAME	campaignName	Кампания	string
SURFACE	surface	Площадки	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Рекламные материалы (файл advertiser_operations_marketing_promo_yandex_market)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
SERVICE_TYPE	serviceType	Тип услуги	string
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Реклама на внешних площадках (файл advertiser_operations_marketing_promo_web)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
SERVICE_TYPE	serviceType	Тип услуги	string
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Реклама на внешних площадках-М (файл advertiser_operations_marketing_promo_web_mark)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
SERVICE_TYPE	serviceType	Тип услуги	string
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист ТВ реклама (файл advertiser_operations_marketing_promo_tv)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
SERVICE_TYPE	serviceType	Тип услуги	string
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Рассылка по сегментам (файл advertiser_operations_marketing_promo_mailing)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
SERVICE_TYPE	serviceType	Тип услуги	string
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Организация и проведение маркет (файл advertiser_operations_marketing_promo_for_sales)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
SERVICE_TYPE	serviceType	Тип услуги	string
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Специальные размещения (файл advertiser_operations_marketing_promo_adfox)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
SERVICE_TYPE	serviceType	Тип услуги	string
CAMPAIGN_NAME	campaignName	Кампания	string
OPERATION_TYPE	operationType	Тип операции	string
CABINET_TYPE	cabinetType	Тип кабинета	string
CABINET_NAME	cabinetName	Название кабинета	string

Лист Отзывы за баллы (файл advertiser_operations_paid_opinion)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
SUM	sum	Сумма (с НДС), ₽	number
BRAND	brand	Бренд	string
CATEGORY	category	Категория	string
MODEL	model	Товар	string
MARKET_URL	marketUrl	Ссылка на Маркет	string

⚙️ Лимит без подписки: 1 запрос в 2 минуты ⭐️ Лимит с подпиской Медиум: 1 запрос в минуту

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/reports/marketing-detalization/generate

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

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

{
  "monthOfYear": {
    "year": 2025,
    "month": 12
  }
}

Name

Description

monthOfYear

Type: ClosureDocumentsMonthOfYearDTO

Период генерации отчета.

Месяц и год.

Example

{
  "year": 2025,
  "month": 12
}

Month

Номер месяца.

Type: integer

Min value: 1

Max value: 12

ClosureDocumentsMonthOfYearDTO

Месяц и год.

Name

Description

month

Type: Month

Номер месяца.

Min value: 1

Max value: 12

Example: 12

year

Type: integer

Год.

Example

{
  "year": 2025,
  "month": 12
}

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

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

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

Была ли статья полезна?

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

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