--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://yandex.ru/dev/market/partner-api/doc/en/reference/reports/generateKeyIndicatorsReport.md - https://yandex.ru/dev/market/partner-api/doc/ru/reference/reports/generateKeyIndicatorsReport.md - https://yandex.ru/dev/market/partner-api/doc/zh/reference/reports/generateKeyIndicatorsReport.md - href: en/reference/reports/generateKeyIndicatorsReport.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/market/partner-api/doc/en/llms.txt {% note warning "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. {% endnote %}
# Report on key indicators {% list tabs %} - Info **The method is available for models: [FBY](https://yandex.ru/dev/market/partner-api/doc/en/overview/fby.md), [FBS](https://yandex.ru/dev/market/partner-api/doc/en/overview/fbs.md), [Express](https://yandex.ru/dev/market/partner-api/doc/en/overview/express.md) and [DBS](https://yandex.ru/dev/market/partner-api/doc/en/overview/dbs.md).** {% cut "**If you are using an API Key token, one of the accesses in the list is required to call the method**" %} * promotion — [Product promotion](https://yandex.ru/dev/market/partner-api/doc/en/_auto/scopes_summary/pages/promotion.md) * promotion:read-only — [View promotion information](https://yandex.ru/dev/market/partner-api/doc/en/_auto/scopes_summary/pages/promotion_read-only.md) * finance-and-accounting — [View financial data and reports](https://yandex.ru/dev/market/partner-api/doc/en/_auto/scopes_summary/pages/finance-and-accounting.md) * all-methods — Full account management * all-methods:read-only — View all data {% endcut %} Starts the generation of a report on key indicators. [What kind of report is this](https://yandex.ru/support/marketplace/ru/analytics/key-metrics) You can find out the generation status and get a link to the finished report using a request. [GET v2/reports/info/{reportId}](https://yandex.ru/dev/market/partner-api/doc/en/reference/reports/getReportInfo.md). Explanation of the report columns: {% cut "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 || |# {% endcut %} {% cut "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 || |# {% endcut %} {% cut "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 || |# {% endcut %} {% cut "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 || |# {% endcut %} {% cut "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 || |# {% endcut %} {% note warning "Ограничения по тарифному плану" %} The data upload period and the number of reports generated at the same time depend on your data plan: * **Without subscription or the "Light" tariff** — data for the last 90 days is available, and 1 report can be generated at a time * **The "Medium" tariff** — data for the last 400 days is available, and up to 10 reports can be generated simultaneously Read more about the subscription for sellers [in the Help of the Market for sellers](https://yandex.ru/support/marketplace/ru/marketing/subscription). {% endnote %} |
**⚙️ Limit without subscription:** 1 request per 2 minutes
**⭐️ [Limit with Medium subscription](https://yandex.ru/support/marketplace/ru/marketing/subscription):** 1 request per minute
| |-| ## Request
POST {.openapi__method} ```text translate=no https://api.partner.market.yandex.ru/v2/reports/key-indicators/generate ```
### Query parameters #| || **Name** | **Description** || || _format_{.json-schema-reset .json-schema-property} {.table-cell}| **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:_{.json-schema-reset .json-schema-value} `FILE` _Enum:_{.json-schema-reset .json-schema-value} `FILE`, `CSV`, `JSON` {.table-cell} || |#{.json-schema-properties}
### Body {% cut "application/json" %} ```json translate=no { "businessId": 1, "campaignId": 1, "detalizationLevel": "WEEK" } ``` {% endcut %} #| || **Name** | **Description** || || _detalizationLevel_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string For which period the details are needed: * `WEEK` — by the week. * `MONTH` — by month. _Enum:_{.json-schema-reset .json-schema-value} `WEEK`, `MONTH` {.table-cell} || || _businessId_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: integer Cabinet ID. To find out, use the request [GET v2/campaigns](https://yandex.ru/dev/market/partner-api/doc/en/reference/campaigns/getCampaigns.md). ℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html) _Min value:_{.json-schema-reset .json-schema-assertion} `1` {.table-cell} || || _campaignId_{.json-schema-reset .json-schema-property} {.table-cell}| **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](https://yandex.ru/dev/market/partner-api/doc/en/reference/campaigns/getCampaigns.md) 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:_{.json-schema-reset .json-schema-assertion} `1` {.table-cell} || |#{.json-schema-properties}
## Responses
## 200 OK In response, you receive an identifier that allows you to find out the generation status and download the finished report.
### Body {% cut "application/json" %} ```json translate=no { "status": "OK", "result": { "reportId": "example", "estimatedGenerationTime": 0 } } ``` {% endcut %} **Type**: object {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and} - {% cut "**Type**: object" %} #| || _status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The type of response. Possible values: * `OK` — There are no errors. * `ERROR` — an error occurred while processing the request. _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR` {.table-cell} || |#{.json-schema-properties} {% endcut %} The standard wrapper for server responses. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK" } ``` {% endcut %} - {% cut "**Type**: object" %} #| || _result_{.json-schema-reset .json-schema-property} {.table-cell}| {% cut "**Type**: object" %} #| || _estimatedGenerationTime_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer Expected generation time in milliseconds. {.table-cell} || || _reportId_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The ID that will be needed to track the generation status and receive the finished report or document. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || |#{.json-schema-properties} {% endcut %} The ID that will be needed to track the generation status and receive the finished report or document. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "reportId": "example", "estimatedGenerationTime": 0 } ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% endcut %} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "result": { "reportId": "example", "estimatedGenerationTime": 0 } } ``` {% endcut %} {% endcut %}
## 400 Bad Request The request contains incorrect data. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#400)
### Body {% cut "application/json" %} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} **Type**: object {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and} - **Type**: object {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and} - **Type**: object #| || _status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The type of response. Possible values: * `OK` — There are no errors. * `ERROR` — an error occurred while processing the request. _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR` {.table-cell} || |#{.json-schema-properties} The standard wrapper for server responses. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK" } ``` {% endcut %} - **Type**: object #| || _errors_{.json-schema-reset .json-schema-property} {.table-cell}| {% cut "**Type**: object[]" %} #| || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The error code. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _message_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Description of the error. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || |#{.json-schema-properties} {% endcut %} A list of errors. _Min items:_{.json-schema-reset .json-schema-assertion} `1` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "code": "example", "message": "example" } ] ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %} A standard wrapper for server errors. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %}
## 401 Unauthorized The authorization data is not specified in the request. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#401)
### Body {% cut "application/json" %} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} **Type**: object {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and} - **Type**: object {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and} - **Type**: object #| || _status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The type of response. Possible values: * `OK` — There are no errors. * `ERROR` — an error occurred while processing the request. _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR` {.table-cell} || |#{.json-schema-properties} The standard wrapper for server responses. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK" } ``` {% endcut %} - **Type**: object #| || _errors_{.json-schema-reset .json-schema-property} {.table-cell}| {% cut "**Type**: object[]" %} #| || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The error code. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _message_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Description of the error. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || |#{.json-schema-properties} {% endcut %} A list of errors. _Min items:_{.json-schema-reset .json-schema-assertion} `1` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "code": "example", "message": "example" } ] ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %} A standard wrapper for server errors. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %}
## 403 Forbidden The authorization data is incorrect or access to the resource is prohibited. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#403)
### Body {% cut "application/json" %} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} **Type**: object {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and} - **Type**: object {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and} - **Type**: object #| || _status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The type of response. Possible values: * `OK` — There are no errors. * `ERROR` — an error occurred while processing the request. _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR` {.table-cell} || |#{.json-schema-properties} The standard wrapper for server responses. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK" } ``` {% endcut %} - **Type**: object #| || _errors_{.json-schema-reset .json-schema-property} {.table-cell}| {% cut "**Type**: object[]" %} #| || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The error code. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _message_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Description of the error. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || |#{.json-schema-properties} {% endcut %} A list of errors. _Min items:_{.json-schema-reset .json-schema-assertion} `1` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "code": "example", "message": "example" } ] ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %} A standard wrapper for server errors. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %}
## 420 Method Failure The resource access limit has been exceeded. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#420)
### Body {% cut "application/json" %} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} **Type**: object {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and} - **Type**: object {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and} - **Type**: object #| || _status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The type of response. Possible values: * `OK` — There are no errors. * `ERROR` — an error occurred while processing the request. _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR` {.table-cell} || |#{.json-schema-properties} The standard wrapper for server responses. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK" } ``` {% endcut %} - **Type**: object #| || _errors_{.json-schema-reset .json-schema-property} {.table-cell}| {% cut "**Type**: object[]" %} #| || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The error code. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _message_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Description of the error. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || |#{.json-schema-properties} {% endcut %} A list of errors. _Min items:_{.json-schema-reset .json-schema-assertion} `1` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "code": "example", "message": "example" } ] ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %} A standard wrapper for server errors. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %}
## 500 Internal Server Error Internal error of the Market. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#500)
### Body {% cut "application/json" %} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} **Type**: object {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and} - **Type**: object {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and} - **Type**: object #| || _status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The type of response. Possible values: * `OK` — There are no errors. * `ERROR` — an error occurred while processing the request. _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR` {.table-cell} || |#{.json-schema-properties} The standard wrapper for server responses. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK" } ``` {% endcut %} - **Type**: object #| || _errors_{.json-schema-reset .json-schema-property} {.table-cell}| {% cut "**Type**: object[]" %} #| || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The error code. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _message_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Description of the error. _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || |#{.json-schema-properties} {% endcut %} A list of errors. _Min items:_{.json-schema-reset .json-schema-assertion} `1` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "code": "example", "message": "example" } ] ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %} A standard wrapper for server errors. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } ``` {% endcut %} {% endcut %}
- Console ```openapi-sandbox translate=no pathParams: [] searchParams: - description: The format of the report or document. name: format in: query required: false schema: description: > 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. type: string enum: - FILE - CSV - JSON default: FILE headers: [] body: |- { "businessId": 1, "campaignId": 1, "detalizationLevel": "WEEK" } schema: description: > The data required to generate the report. The request must contain either `businessId`, or `campaignId` but not both at once. type: object required: - detalizationLevel properties: businessId: description: "Cabinet ID. {% if audience == \"partner\" %} To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html)\n\n:::no-translate\n{% endif %}\n:::\n\n" type: integer format: int64 minimum: 1 campaignId: description: "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.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 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**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n" type: integer format: int64 minimum: 1 detalizationLevel: description: | For which period the details are needed: * `WEEK` — by the week. * `MONTH` — by 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 ``` {% endlist %}
[*Deprecated]: No longer supported, please use an alternative and newer version.