The structure and content of the reports are subject to change without prior notice.

For example, a new column may be added or the name of the sheet may change.

Report on key indicators

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

promotion — Product promotion
finance-and-accounting — View financial data and reports
all-methods — Full account management

Starts the generation of a report on key indicators. What kind of report is this

You can find out the generation status and get a link to the finished report using a request. GET v2/reports/info/{reportId}.

Explanation of the report columns:

Sheet Основные (file key_indicators_summary)

CSV column name	JSON column name	XLSX column name	Value type
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

Sheet Выручка (file key_indicators_revenue)

CSV column name	JSON column name	XLSX column name	Value type
PERIOD	period	Период	string
GMV	gmv	Выручка, ₽	number
TOTAL_SUBSIDY	totalSubsidy	Все платежи за скидки, ₽	number
YANDEX_PLUS	yandexPlus	Платежи за скидки по баллам Яндекс Плюса, ₽	number
SUBSIDY	subsidy	Платежи за скидки маркетплейса, ₽	number

Sheet Показатели продаж (file key_indicators_sales)

CSV column name	JSON column name	XLSX column name	Value type
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

Sheet Расходы (file key_indicators_expenses)

CSV column name	JSON column name	XLSX column name	Value type
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

Sheet Все (file key_indicators_full)

CSV column name	JSON column name	XLSX column name	Value type
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

⚙️ Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/reports/key-indicators/generate

Query parameters

Name

Description

format

Type: string

The format of the report or document. Report format:

FILE — the spreadsheet file (XLSX).
CSV — A ZIP archive with CSV files for each report sheet.
JSON — A ZIP archive with JSON files for each report sheet.

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

{
  "businessId": 1,
  "campaignId": 1,
  "detalizationLevel": "WEEK"
}

Name	Description
detalizationLevel	Type: string For which period the details are needed: `WEEK` — by the week. `MONTH` — by month. Enum: `WEEK`, `MONTH`
businessId	Type: integer Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market? Min value: `1`
campaignId	Type: integer The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction. You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules: block Campaign ID; tab Query log → drop-down list in the block Show logs. ⚠️ Do not confuse it with: the store's identifier, which is displayed in the merchant's personal account. advertising campaigns. Min value: `1`

Responses

200 OK

In response, you receive an identifier that allows you to find out the generation status and download the finished report.

Body

application/json

{
  "status": "OK",
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

estimatedGenerationTime

Type: integer

Expected generation time in milliseconds.

reportId

Type: string

The ID that will be needed to track the generation status and receive the finished report or document.

Example: example

The ID that will be needed to track the generation status and receive the finished report or document.

Example

{
  "reportId": "example",
  "estimatedGenerationTime": 0
}

Example

{
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Was the article helpful?

Sales Geography Report

Competitive Position Report