Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

Отчет «Аналитика продаж»

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса 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

Формат отчета или документа.

ReportFormatType

Формат отчета:

  • FILE — файл с электронной таблицей (XLSX).
  • CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
  • JSON — ZIP-архив с JSON-файлами на каждый лист отчета.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "businessId": 0,
    "campaignId": 0,
    "dateFrom": "string",
    "dateTo": "string",
    "grouping": "CATEGORIES"
}

Name

Description

dateFrom*

Type: string<date>

Начало периода, включительно.

dateTo*

Type: string<date>

Конец периода, включительно.

grouping*

Type: ShowsSalesGroupingType

Группировка данных отчета.

Enum: CATEGORIES, OFFERS

businessId

Type: integer<int64>

Идентификатор кабинета.

Указывается, если нужно составить отчет по всем магазинам в кабинете. В запросе обязательно должен быть либо businessId, либо campaignId, но не оба сразу.

campaignId

Type: integer<int64>

Идентификатор кампании.

Указывается, если нужно составить отчет по конкретному магазину. В запросе обязательно должен быть либо businessId, либо campaignId, но не оба сразу.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

ShowsSalesGroupingType

Группировка данных отчета. Возможные значения:

  • CATEGORIES — группировка по категориям.
  • OFFERS — группировка по товарам.

Type

Description

ShowsSalesGroupingType

Enum: CATEGORIES, OFFERS

Responses

200 OK

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.

Body

application/json
{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

result

Type: GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Ожидаемая продолжительность генерации в миллисекундах.

reportId*

Type: string

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

Предыдущая
Закрывающие документы
Следующая
Отчет по бусту показов