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

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

Отчет по ключевым показателям

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

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

Запускает генерацию отчета по ключевым показателям. Что это за отчет

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

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

Лист Основные (файл key_indicators_summary)

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

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

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

Тип значения

PERIOD

period

Период

string

GMV

gmv

Выручка, ₽

number

ORDERS_DELIVERED

ordersDelivered

Доставленные заказы, шт.

integer

ORDERS_AVG_PRICE

ordersAvgPrice

Средний чек заказа, ₽

number

TOTAL_SUBSIDY

totalSubsidy

Все платежи за скидки, ₽

number

SERVICES_WITHOUT_PROMOTION

servicesWithoutPromotion

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

number

PROMOTION_SERVICES

promotionServices

Стоимость услуг продвижения, ₽

number

Лист Выручка (файл key_indicators_revenue)

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

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

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

Тип значения

PERIOD

period

Период

string

GMV

gmv

Выручка, ₽

number

TOTAL_SUBSIDY

totalSubsidy

Все платежи за скидки, ₽

number

YANDEX_PLUS

yandexPlus

Платежи за скидки по баллам Яндекс Плюса, ₽

number

SUBSIDY

subsidy

Платежи за скидки маркетплейса, ₽

number

Лист Показатели продаж (файл key_indicators_sales)

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

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

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

Тип значения

PERIOD

period

Период

string

SHOWS

shows

Показы товаров

integer

TO_CART_CONVERSION

toCartConversion

Конверсия добавления в корзину, %

number

TO_ORDER_CONVERSION

toOrderConversion

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

number

ORDERS_DELIVERED

ordersDelivered

Доставленные заказы, шт.

integer

GMV

gmv

Выручка, ₽

number

ORDERS_AVG_PRICE

ordersAvgPrice

Средний чек заказа, ₽

number

ORDER_ITEMS_DELIVERED

orderItemsDelivered

Доставленные товары, шт

integer

ORDER_ITEM_AVG_PRICE

orderItemAvgPrice

Средняя стоимость доставленного товара, ₽

number

Лист Расходы (файл key_indicators_expenses)

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

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

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

Тип значения

PERIOD

period

Период

string

SERVICES_WITHOUT_PROMOTION

servicesWithoutPromotion

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

number

FEE

fee

Стоимость размещения товаров на витрине, ₽

number

PAYMENT_ACCEPTANCE_AND_TRANSFER

paymentAcceptanceAndTransfer

Приём и перевод платежа покупателя, ₽

number

LOGISTIC_SERVICES

logisticServices

Стоимость услуг логистики, ₽

number

WAREHOUSE_SERVICES

warehouseServices

Стоимость услуг склада, ₽

number

PROMOTION_SERVICES

promotionServices

Стоимость услуг продвижения, ₽

number

BOOST

boost

Расходы на буст продаж, ₽

number

PROMOTION_WITH_SHOWS

promotionWithShows

Расходы на продвижение с оплатой за показы, ₽

number

LOYALTY_PARTICIPATION_FEE

loyaltyParticipationFee

Участие в программе лояльности и отзывы, ₽

number

EXTENDED_ACCESS_PAYMENT

extendedAccessPayment

Расширенный доступ к сервисам Маркетплейса, ₽

number

Лист Все (файл key_indicators_full)

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

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

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

Тип значения

PERIOD

period

Период

string

SHOWS

shows

Показы товаров

integer

TO_CART_CONVERSION

toCartConversion

Конверсия добавления в корзину, %

number

TO_ORDER_CONVERSION

toOrderConversion

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

number

ORDERS_DELIVERED

ordersDelivered

Доставленные заказы, шт.

integer

GMV

gmv

Выручка, ₽

number

ORDERS_AVG_PRICE

ordersAvgPrice

Средний чек заказа, ₽

number

ORDER_ITEMS_DELIVERED

orderItemsDelivered

Доставленные товары, шт

integer

ORDER_ITEM_AVG_PRICE

orderItemAvgPrice

Средняя стоимость доставленного товара, ₽

number

TOTAL_SUBSIDY

totalSubsidy

Все платежи за скидки, ₽

number

YANDEX_PLUS

yandexPlus

Платежи за скидки по баллам Яндекс Плюса, ₽

number

SUBSIDY

subsidy

Платежи за скидки маркетплейса, ₽

number

SERVICES_WITHOUT_PROMOTION

servicesWithoutPromotion

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

number

FEE

fee

Стоимость размещения товаров на витрине, ₽

number

PAYMENT_ACCEPTANCE_AND_TRANSFER

paymentAcceptanceAndTransfer

Приём и перевод платежа покупателя, ₽

number

LOGISTIC_SERVICES

logisticServices

Стоимость услуг логистики, ₽

number

WAREHOUSE_SERVICES

warehouseServices

Стоимость услуг склада, ₽

number

PROMOTION_SERVICES

promotionServices

Стоимость услуг продвижения, ₽

number

BOOST

boost

Расходы на буст продаж, ₽

number

PROMOTION_WITH_SHOWS

promotionWithShows

Расходы на продвижение с оплатой за показы, ₽

number

LOYALTY_PARTICIPATION_FEE

loyaltyParticipationFee

Участие в программе лояльности и отзывы, ₽

number

EXTENDED_ACCESS_PAYMENT

extendedAccessPayment

Расширенный доступ к сервисам Маркетплейса, ₽

number

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

Request

POST

https://api.partner.market.yandex.ru/reports/key-indicators/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,
    "campaignId": 0,
    "detalizationLevel": "WEEK"
}

Name

Description

detalizationLevel*

Type: KeyIndicatorsReportDetalizationLevelType

За какой период нужна детализация.

Enum: WEEK, MONTH

businessId

Type: integer<int64>

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

Указывается, если нужно составить отчет по всем магазинам в кабинете. В запросе обязательно должен быть либо businessId, либо campaignId, но не оба сразу.

campaignId

Type: integer<int64>

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

Указывается, если нужно составить отчет по конкретному магазину. В запросе обязательно должен быть либо businessId, либо campaignId, но не оба сразу.

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

  • Модули и API → блок Передача данных Маркету.
  • Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

KeyIndicatorsReportDetalizationLevelType

За какой период нужна детализация:

  • WEEK — по неделям.

  • MONTH — по месяцам.

Type

Description

KeyIndicatorsReportDetalizationLevelType

Enum: WEEK, MONTH

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.