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

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

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

Info

Console

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

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

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

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

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET v2/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/v2/reports/key-indicators/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,
  "campaignId": 1,
  "detalizationLevel": "WEEK"
}

Name	Description
detalizationLevel	Type: KeyIndicatorsReportDetalizationLevelType За какой период нужна детализация. За какой период нужна детализация: `WEEK` — по неделям. `MONTH` — по месяцам. Enum: `WEEK`, `MONTH`
businessId	Type: BusinessId Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns. ℹ️ Что такое кабинет и магазин на Маркете Min value: `1` Example: `1`
campaignId	Type: CampaignId Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули: блок Идентификатор кампании; вкладка Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не путайте его с: идентификатором магазина, который отображается в личном кабинете продавца; рекламными кампаниями. Min value: `1` Example: `1`

BusinessId

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

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

Type: integer

Min value: 1

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

блок Идентификатор кампании;
вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

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

Type: integer

Min value: 1

KeyIndicatorsReportDetalizationLevelType

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

WEEK — по неделям.
MONTH — по месяцам.

Type: string

Enum: WEEK, MONTH

Responses

200 OK

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

Body

application/json

{
  "status": "OK"
}

Type: object

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

Type: object

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

401 Unauthorized

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

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

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

Body

application/json

{
  "status": "OK"
}

Type: object

pathParams: []
searchParams:
  - description: Формат отчета или документа.
    name: format
    in: query
    required: false
    schema:
      $ref: >-
        /home/sandbox/.ya/build/build_root/3vjl/00000b/market/mbi/docs/partner-api/docfiles/__docsbuild/.tmp_input/ru/openapi/partner-api-spec/reports/schemas.yaml#/ReportFormatType
headers: []
body: |-
  {
    "businessId": 1,
    "campaignId": 1,
    "detalizationLevel": "WEEK"
  }
schema:
  description: >
    Данные, необходимые для генерации отчета.


    В запросе обязательно должен быть либо `businessId`, либо `campaignId`, но
    не оба сразу.
  type: object
  required:
    - detalizationLevel
  properties:
    businessId:
      description: "Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)\n"
      type: integer
      format: int64
      minimum: 1
    campaignId:
      description: "Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.\n\nЕго можно узнать с помощью запроса [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → **Настройки** и в меню слева выберите **API и модули**:\n\n* блок **Идентификатор кампании**;\n* вкладка **Лог запросов** → выпадающий список в блоке **Показывать логи**.\n\n⚠️ Не путайте его с:\n- идентификатором магазина, который отображается в личном кабинете продавца;\n- рекламными кампаниями.\n"
      type: integer
      format: int64
      minimum: 1
    detalizationLevel:
      description: За какой период нужна детализация.
      $ref: '#/$defs/KeyIndicatorsReportDetalizationLevelType'
  $defs:
    /home/sandbox/.ya/build/build_root/3vjl/00000b/market/mbi/docs/partner-api/docfiles/__docsbuild/.tmp_input/ru/openapi/partner-api-spec/reports/api/generateKeyIndicatorsReport.yaml#/KeyIndicatorsReportDetalizationLevelType:
      description: |
        За какой период нужна детализация:

        * `WEEK` — по неделям.

        * `MONTH` — по месяцам.
      type: string
      enum:
        - WEEK
        - MONTH
bodyType: application/json
method: post
security:
  - type: apiKey
    name: Api-Key
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/reports/key-indicators/generate
host: https://api.partner.market.yandex.ru

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

Отчет по географии продаж

Отчет «Конкурентная позиция»