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 be changed.
Sales Analytics Report
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
- finance-and-accounting — View financial data and reports
- all-methods — Full account management
Starts the generation of the Sales Analytics report for the specified period. 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 sales_funnel_report)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
DAY |
day |
День |
string |
|
MONTH |
month |
Месяц |
string |
|
YEAR |
year |
Год |
integer |
|
CATEGORY_NAME |
categoryName |
Категория |
string |
|
BRAND_NAME |
brandName |
Бренд |
string |
|
OFFER_ID |
offerId |
Ваш SKU |
string |
|
OFFER_NAME |
offerName |
Название товара |
string |
|
BY_MSKU_SHOWS |
byMskuShows |
Показы товаров всех продавцов, шт. |
integer |
|
VISIBILITY_INDEX |
visibilityIndex |
Индекс видимости, % |
string |
|
SHOWS |
shows |
Показы моих товаров, шт. |
integer |
|
SHOWS_WITH_PROMOTION |
showsWithPromotion |
Показы моих товаров с акциями, шт. |
integer |
|
SHOWS_SHARE |
showsShare |
Доля показов с бустом, % |
number |
|
CLICKS |
clicks |
Клики по товарам, шт. |
integer |
|
CLICKS_WITH_PROMOTION |
clicksWithPromotion |
Клики по товарам с акциями, шт. |
integer |
|
TO_CART_CONVERSION |
toCartConversion |
Конверсия из показа в корзину, % |
number |
|
TO_CART |
toCart |
Добавления в корзину, шт. |
integer |
|
TO_CART_WITH_PROMOTION |
toCartWithPromotion |
Добавления в корзину по акциям, шт. |
integer |
|
TO_CART_SHARE |
toCartShare |
Доля добавлений товаров с бустом в корзину, % |
number |
|
ORDER_ITEMS |
orderItems |
Заказанные товары, шт. |
integer |
|
ORDER_ITEMS_WITH_PROMOTION |
orderItemsWithPromotion |
Заказанные товары по акциям, шт. |
integer |
|
ORDER_ITEMS_TOTAL_AMOUNT |
orderItemsTotalAmount |
Заказано товаров на сумму, ₽ |
integer |
|
ORDER_ITEMS_TOTAL_AMOUNT_WITH_PROMOTION |
orderItemsTotalAmountWithPromotion |
Заказано товаров с акциями на сумму, ₽ |
integer |
|
TO_ORDER_CONVERSION |
toOrderConversion |
Конверсия из корзины в заказ, % |
number |
|
ORDER_ITEMS_SHARE |
orderItemsShare |
Доля заказанных товаров с бустом, % |
number |
|
ORDER_ITEMS_DELIVERED_COUNT |
orderItemsDeliveredCount |
Доставлено за период, шт. |
integer |
|
ORDER_ITEMS_DELIVERED_COUNT_WITH_PROMOTION |
orderItemsDeliveredCountWithPromotion |
Доставлено за период по акциям, шт. |
string |
|
ORDER_ITEMS_DELIVERED_TOTAL_AMOUNT |
orderItemsDeliveredTotalAmount |
Доставлено за период на сумму, ₽ |
integer |
|
ORDER_ITEMS_DELIVERED_TOTAL_AMOUNT_WITH_PROMOTION |
orderItemsDeliveredTotalAmountWithPromotion |
Доставлено за период по акциям на сумму, ₽ |
integer |
|
ORDER_ITEMS_DELIVERED_FROM_ORDERED_COUNT |
orderItemsDeliveredFromOrderedCount |
Доставлено из заказанных за период, шт. |
integer |
|
ORDER_ITEMS_DELIVERED_FROM_ORDERED_TOTAL_AMOUNT |
orderItemsDeliveredFromOrderedTotalAmount |
Доставлено из заказанных на сумму за период, ₽ |
integer |
|
ORDER_ITEMS_DELIVERED_FROM_ORDERED_TOTAL_AMOUNT_WITH_PROMOTION |
orderItemsDeliveredFromOrderedTotalAmountWithPromotion |
Доставлено из заказанных на сумму за период по акциям, ₽ |
integer |
|
ORDER_ITEMS_CANCELED_COUNT |
orderItemsCanceledCount |
Отмены и невыкупы за период, шт. |
integer |
|
ORDER_ITEMS_CANCELED_BY_CREATED_AT_COUNT |
orderItemsCanceledByCreatedAtCount |
Отмены и невыкупы заказанного за период, шт. |
integer |
|
ORDER_ITEMS_RETURNED_COUNT |
orderItemsReturnedCount |
Возвращённые товары за период, шт. |
integer |
|
ORDER_ITEMS_RETURNED_BY_CREATED_AT_COUNT |
orderItemsReturnedByCreatedAtCount |
Возвраты заказанного за период, шт. |
integer |
| ⚙️ Limit: 10 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/shows-sales/generate
Query parameters
|
Name |
Description |
|
format |
Type: string The format of the report or document. Report format:
Default: Enum: |
Body
application/json
{
"businessId": 1,
"campaignId": 1,
"dateFrom": "2025-08-22",
"dateTo": "2025-09-22",
"grouping": "CATEGORIES"
}
|
Name |
Description |
|
dateFrom |
Type: string<date> The beginning of the period, inclusive. Date format: Example: |
|
dateTo |
Type: string<date> End of the period, inclusive. Date format: Example: |
|
grouping |
Type: string Grouping of report data. Possible values:
Enum: |
|
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: |
|
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:
⚠️ Do not confuse it with:
Min value: |
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"
}
Type: object
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
404 Not Found
The requested resource was not found. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
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,
"dateFrom": "2025-08-22",
"dateTo": "2025-09-22",
"grouping": "CATEGORIES"
}
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:
- dateFrom
- dateTo
- grouping
properties:
businessId:
description: "Cabinet ID. 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"
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
dateFrom:
type: string
format: date
description: |
The beginning of the period, inclusive.
Date format: `YYYY-MM-DD`.
example: '2025-08-22'
dateTo:
type: string
format: date
description: |
End of the period, inclusive.
Date format: `YYYY-MM-DD`.
example: '2025-09-22'
grouping:
type: string
description: |
Grouping of report data.
Possible values:
* `CATEGORIES` — grouping by category.
* `OFFERS` — grouping by product.
enum:
- CATEGORIES
- OFFERS
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/shows-sales/generate
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.