Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
Отчет «Аналитика продаж»
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- finance-and-accounting — Просмотр финансовой информации и отчётности
- all-methods — Полное управление кабинетом
Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET v2/reports/info/{reportId}.
Пояснение к колонкам отчета:
Лист Аналитика продаж (файл sales_funnel_report)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
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 |
| ⚙️ Лимит: 10 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/shows-sales/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType Формат отчета или документа. Формат отчета:
Default: Enum: |
ReportFormatType
Формат отчета:
FILE— файл с электронной таблицей (XLSX).CSV— ZIP-архив с CSV-файлами на каждый лист отчета.JSON— ZIP-архив с JSON-файлами на каждый лист отчета.
Type: string
Default: FILE
Enum: FILE, CSV, JSON
Body
application/json
{
"businessId": 1,
"campaignId": 1,
"dateFrom": "2025-08-22",
"dateTo": "2025-09-22",
"grouping": "CATEGORIES"
}
|
Name |
Description |
|
dateFrom |
Type: PeriodDateFrom Начало периода, включительно. Формат даты: Example: |
|
dateTo |
Type: PeriodDateTo Конец периода, включительно. Формат даты: Example: |
|
grouping |
Type: ShowsSalesGroupingType Группировка данных отчета. Группировка данных отчета. Возможные значения:
Enum: |
|
businessId |
Type: BusinessId Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns. ℹ️ Что такое кабинет и магазин на Маркете Min value: Example: |
|
campaignId |
Type: CampaignId Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не путайте его с:
Min value: Example: |
BusinessId
Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
Type: integer
Min value: 1
CampaignId
Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.
Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
- блок Идентификатор кампании;
- вкладка Лог запросов → выпадающий список в блоке Показывать логи.
⚠️ Не путайте его с:
- идентификатором магазина, который отображается в личном кабинете продавца;
- рекламными кампаниями.
Type: integer
Min value: 1
PeriodDateFrom
Начало периода, включительно.
Формат даты: ГГГГ-ММ-ДД.
Type: string<date>
Example: 2025-08-22
PeriodDateTo
Конец периода, включительно.
Формат даты: ГГГГ-ММ-ДД.
Type: string<date>
Example: 2025-09-22
ShowsSalesGroupingType
Группировка данных отчета. Возможные значения:
CATEGORIES— группировка по категориям.OFFERS— группировка по товарам.
Type: string
Enum: CATEGORIES, OFFERS
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "example",
"estimatedGenerationTime": 0
}
}
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
result
Type: GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.
Example
{ "reportId": "example", "estimatedGenerationTime": 0 }Example
{ "result": { "reportId": "example", "estimatedGenerationTime": 0 } }
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.
|
Name |
Description |
|
estimatedGenerationTime |
Type: integer Ожидаемая продолжительность генерации в миллисекундах. |
|
reportId |
Type: string Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. Example: |
Example
{
"reportId": "example",
"estimatedGenerationTime": 0
}
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. 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:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
No longer supported, please use an alternative and newer version.