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

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

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:

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": 0,
    "campaignId": 0,
    "dateFrom": "2025-08-22",
    "dateTo": "2025-09-22",
    "grouping": "CATEGORIES"
}

Name	Description
dateFrom*	Type: string<date> The beginning of the period, inclusive. Date format: `YYYY-MM-DD`. Example: `2025-08-22`
dateTo*	Type: string<date> End of the period, inclusive. Date format: `YYYY-MM-DD`. Example: `2025-09-22`
grouping*	Type: string Grouping of report data. Possible values: `CATEGORIES` — grouping by category. `OFFERS` — grouping by product. Enum: `CATEGORIES`, `OFFERS`
businessId	Type: integer<int64> Cabinet ID. It is indicated if you need to create a report on all stores in the cabinet. The request must contain either `businessId`, or `campaignId` but not both at once.
campaignId	Type: integer<int64> The campaign ID. It is indicated if you need to create a report on a specific store. The request must contain either `businessId`, or `campaignId` but not both at once. 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 send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

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": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

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

result

Type: object

estimatedGenerationTime*

Type: integer<int64>

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.

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

401 Unauthorized

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

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

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": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

Was the article helpful?

Transfer and confirmation of the refund decision

Sales Geography Report