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

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

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

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

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

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

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

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

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

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

Тип значения

DATE

date

Дата

string

INCUT_ID

incutId

ID кампании

integer

TITLE

title

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

string

SKU

sku

SKU товара

string

SKU_NAME

skuName

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

string

TO_CART

toCart

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

integer

ORDERED

ordered

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

integer

ORDERED_AMOUNT

orderedAmount

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

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

Request

POST

https://api.partner.market.yandex.ru/v2/reports/shelf-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",
    "attributionType": "CLICKS"
}

Name

Description

attributionType*

Type: StatisticsAttributionType

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

Enum: CLICKS, SHOWS

businessId*

Type: integer<int64>

Идентификатор кабинета.

dateFrom*

Type: string<date>

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

dateTo*

Type: string<date>

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

StatisticsAttributionType

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

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

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

Type

Description

StatisticsAttributionType

Enum: CLICKS, SHOWS

Responses

200 OK

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.

Body

application/json
{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GenerateReportDTO

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GenerateReportDTO

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

Name

Description

estimatedGenerationTime*

Type: integer<int64>

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

reportId*

Type: string

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

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.

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