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

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

Отчет по полкам

Info

Console

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

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

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

Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.

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

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

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

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
INCUT_ID	incutId	ID кампании	integer
TITLE	title	Название кампании	string
IMPRESSIONS	impressions	Показы, шт.	integer
COVERAGE	coverage	Охват, чел.	integer
CLICKS	clicks	Клики, шт.	integer
CTR	ctr	CTR, %	number
AVERAGE_IMPRESSION_FREQUENCY	averageImpressionFrequency	Частота показа	number
TO_CART	toCart	Добавления в корзину, шт.	integer
ORDERED	ordered	Заказанные товары, шт.	integer
CONVERSION	conversion	Конверсия в заказы, %	number
ORDERED_AMOUNT	orderedAmount	Стоимость заказанных товаров, ₽	number
CPO	cpo	СРО, ₽	number
COST	cost	Расчётные расходы, ₽	number
CPM	cpm	CPM, ₽	number
DRR	drr	Доля расчётных расходов от выручки с полкой	number
REAL_COST	realCost	Фактические расходы (с НДС), ₽	number
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number

Лист Таргетинг по категориям (файл shelfs_statistics_by_category)

Название колонки в CSV	Название колонки в JSON	Название колонки в XLSX	Тип значения
DATE	date	Дата	string
INCUT_ID	incutId	ID кампании	integer
TITLE	title	Название кампании	string
SHOW_CATEGORY_NAME	showCategoryName	Категория показа полки	string
IMPRESSIONS	impressions	Показы, шт.	integer
COVERAGE	coverage	Охват, чел.	integer
CLICKS	clicks	Клики, шт.	integer
CTR	ctr	CTR, %	number
AVERAGE_IMPRESSION_FREQUENCY	averageImpressionFrequency	Частота показа	number
TO_CART	toCart	Добавления в корзину, шт.	integer
ORDERED	ordered	Заказанные товары, шт.	integer
CONVERSION	conversion	Конверсия в заказы, %	number
ORDERED_AMOUNT	orderedAmount	Стоимость заказанных товаров, ₽	number
CPO	cpo	СРО, ₽	number
COST	cost	Расчётные расходы, ₽	number
CPM	cpm	CPM, ₽	number
DRR	drr	Доля расчётных расходов от выручки с полкой	number

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

Request

POST

https://api.partner.market.yandex.ru/v2/reports/shelf-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-01-01",
  "dateTo": "2025-01-01",
  "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: string<date> Начало периода, включительно. Example: `2025-01-01`
dateTo	Type: string<date> Конец периода, включительно. Example: `2025-01-01`

BusinessId

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

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

Type: integer

Min value: 1

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

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

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

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

Отчет по бусту продаж

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