Поиск
API docs by Redocly

Аналитика и данные (analytics)

Узнать больше об аналитике и данных можно в справочном центре

В данном разделе доступны методы получения:

  1. Статистики по продвижению
  2. Воронки продаж
  3. Поисковых запросов
  4. Истории остатков
  5. Аналитики продавца в формате CSV

Аналитика и данные

Узнать больше об аналитике и данных можно в справочном центре

В данном разделе доступны методы получения:

  1. Статистики по продвижению
  2. Воронки продаж
  3. Поисковых запросов
  4. Истории остатков
  5. Аналитики продавца в формате CSV

Статистика кампаний{{ /adv/v2/fullstats }}

Описание метода

Метод формирует статистику для всех кампаний, независимо от типа.

Данные вернутся для кампаний в статусах:

  • 7 — завершена
  • 9 — идут показы
  • 11 — пауза из-за расхода бюджета

Если в запросе указан только ID кампании, по ней вернутся данные только за последние сутки.

В запросе можно передавать один из параметров: dates либо interval, но не оба сразу.
Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
One of
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
id
integer

ID кампании

dates
Array of strings <date> [ items <date > ]

Даты, за которые нужно получить информацию

Responses

Request samples

Content type
application/json
Example

Запрос с датами

[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example

Ответ при запросе с полем date

[
  • {
    }
]

Статистика автоматической кампании по кластерам фраз{{ /adv/v2/auto/stat-words }}

Описание метода

Метод формирует кластеры ключевых — то есть, наборы похожих — фраз из поисковой строки, если по ним хотя бы один раз были показаны товары из кампании. В ответе метода также указано количество показов этих товаров.

Информация обновляется каждые 15 минут.

Максимум 4 запроса в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
{
  • "excluded": [
    ],
  • "clusters": [
    ]
}

Статистика поисковой кампании по ключевым фразам{{ /adv/v1/stat/words }}

Описание метода

Метод формирует статистику кампании типа Поиск по ключевым фразам из поисковой строки: количество просмотров товара и затраты по одной ключевой фразе.

Информация обновляется каждые 30 минут.

Тип рекламных кампаний Поиск устарел.
Максимум 4 запроса в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
application/json
{
  • "words": {
    },
  • "stat": [
    ]
}

Статистика по ключевым фразам{{ /adv/v0/stats/keywords }}

Описание метода

Метод формирует статистику по ключевым фразам из поисковой строки: количество просмотров товара и затраты по одной ключевой фразе. Подходит для автоматических кампаний и Аукционов.

Статистика формируется за каждый день, когда кампания была активна. В одном запросе можно получить данные максимум за 7 дней.
Данные обновляются каждый час.

Максимум 4 запроса в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
advert_id
required
integer
Example: advert_id=123456789

ID кампании

from
required
string <date>
Example: from=2024-08-10

Начало периода

to
required
string <date>
Example: to=2024-08-12

Конец периода

Responses

Response samples

Content type
application/json
{
  • "keywords": [
    ]
}

Статистика медиакампаний{{ /adv/v1/stats }}

Описание метода

Метод формирует статистику кампаний сервиса ВБ.Медиа. Статистику можно группировать по датам и/или интервалам.

Максимум 10 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
One of
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
id
integer

ID кампании

dates
Array of strings <date> [ items <date > ]

Даты, за которые нужно получить информацию

Responses

Request samples

Content type
application/json
Example

Запрос с датами

[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example

Ответ при запросе с интервалами

[
  • {
    }
]

Воронка продаж

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике воронки продаж можно в справочном центре

Методы получения статистики:

  1. Карточек товаров за период
  2. Групп карточек товаров за период
  3. Карточек товаров по дням
  4. Групп карточек товаров по дням
Таймзоны представлены в формате IANA, актуальный список можно посмотреть здесь

Статистика карточек товаров за период{{ /api/v2/nm-report/detail }}

Описание метода

Метод формирует отчёт о товарах, сравнивая ключевые показатели — например, добавления в корзину, заказы и переходы в карточку товара — за текущий период с аналогичным прошлым.

Параметры brandNames,objectIDs, tagIDs, nmIDs могут быть пустыми [], тогда в ответе возвращаются все карточки продавца.

Если выбрано несколько параметров, в ответе будут карточки, в которых есть одновременно все эти параметры. Если карточки не подходят по параметрам запроса, вернётся пустой ответ [].

Можно получить отчёт максимум за последние 365 дней.

В данных предыдущего периода:

  • Данные в previousPeriod указаны за такой же период, что и в selectedPeriod.
  • Если дата начала previousPeriod раньше, чем год назад от текущей даты, она будет приведена к виду: previousPeriod.begin = текущая дата — 365 дней.
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
brandNames
Array of strings

Бренд

objectIDs
Array of integers <int32> [ items <int32 > ]

ID предмета

tagIDs
Array of integers <int32> [ items <int32 > ]

ID ярлыка

nmIDs
Array of integers <int32> [ items <int32 > ]

Артикул WB

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

required
object

Период

object

Параметры сортировки. Если не указано, то по умолчанию используется значение "openCard" и сортировка по убыванию.

Все виды сортировки field:
openCard — по открытию карточки (переход на страницу товара)
addToCart — по добавлениям в корзину
orders — по кол-ву заказов
avgRubPrice — по средней цене в рублях
ordersSumRub — по сумме заказов в рублях
stockMpQty — по кол-ву остатков маркетплейса шт.
stockWbQty — по кол-ву остатков на складе шт.
cancelSumRub — сумме возвратов в рублях
cancelCount — по кол-ву возвратов
buyoutCount — по кол-ву выкупов
buyoutSumRub — по сумме выкупов
page
required
integer <int32>

Страница

Responses

Request samples

Content type
application/json
{
  • "brandNames": [
    ],
  • "objectIDs": [
    ],
  • "tagIDs": [
    ],
  • "nmIDs": [
    ],
  • "timezone": "Europe/Moscow",
  • "period": {
    },
  • "orderBy": {
    },
  • "page": 1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Статистика групп карточек товаров за период{{ /api/v2/nm-report/grouped }}

Описание метода

Метод формирует отчёт о товарах, сравнивая ключевые показатели — например, добавления в корзину, заказы и переходы в карточку товара — за текущий период с аналогичным прошлым. Карточки товаров сгруппированы по предметам, брендам и ярлыкам.

Параметры brandNames, objectIDs, tagIDs могут быть пустыми [], тогда группировка происходит по всем карточкам продавца.

Можно получить отчёт максимум за последние 365 дней.

В данных предыдущего периода:

  • Данные в previousPeriod указаны за такой же период, что и в selectedPeriod.
  • Если дата начала previousPeriod раньше, чем год назад от текущей даты, она будет приведена к виду: previousPeriod.begin = текущая дата — 365 дней.
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
objectIDs
Array of integers <int32> [ items <int32 > ]

ID предмета

brandNames
Array of strings

Бренд

tagIDs
Array of integers <int32> [ items <int32 > ]

ID ярлыка

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

required
object

Период

object

Параметры сортировки. Если не указано, то по умолчанию используется значение "openCard" и сортировка по убыванию.

Все виды сортировки field:
openCard — по открытию карточки (переход на страницу товара)
addToCart — по добавлениям в корзину
orders — по кол-ву заказов
avgRubPrice — по средней цене в рублях
ordersSumRub — по сумме заказов в рублях
stockMpQty — по кол-ву остатков маркетплейса шт.
stockWbQty — по кол-ву остатков на складе шт.
page
required
integer <int32>

Страница

Responses

Request samples

Content type
application/json
{
  • "objectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "timezone": "Europe/Moscow",
  • "period": {
    },
  • "orderBy": {
    },
  • "page": 1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Статистика карточек товаров по дням{{ /api/v2/nm-report/detail/history }}

Описание метода

Метод предоставляет статистику карточек товаров по дням. Можно получить данные по добавлениям в корзину, заказам, переходам в карточку товара и так далее.

Можно получить данные максимум за последнюю неделю.

Чтобы получать отчёты за период до года, подпишитесь на расширенную аналитику Джем
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
required
Array of integers <int32> [ items <int32 > ]

Артикул WB (максимум 20)

required
object

Период

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

aggregationLevel
string

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Статистика групп карточек товаров по дням{{ /api/v2/nm-report/grouped/history }}

Описание метода

Метод предоставляет статистику карточек товаров по дням. Карточки товаров сгруппированы по предметам, брендам и ярлыкам. Можно получить данные по добавлениям в корзину, заказам, переходам в карточку товара и так далее.

Параметры brandNames, objectIDs, tagIDs могут быть пустыми [], тогда группировка происходит по всем карточкам продавца.

Произведение количества предметов, брендов, ярлыков в запросе может быть не больше 16.

Можно получить данные максимум за последнюю неделю.

Чтобы получать отчёты за период до года, подпишитесь на расширенную аналитику Джем
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
objectIDs
Array of integers <int32> [ items <int32 > ]

ID предмета

brandNames
Array of strings

Бренд

tagIDs
Array of integers <int32> [ items <int32 > ]

ID ярлыка

required
object

Период

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

aggregationLevel
string

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "objectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Поисковые запросы

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике поисковых запросов можно в справочном центре

Методы получения отчёта по поисковым запросам, в частности:

  1. Основной страницы
  2. Дополнительных данных к основной странице с пагинацией по группам или пагинацией по товарам в группе
  3. Поисковых запросов по товару
  4. Заказов и позиций по поисковым запросам товара
Вы можете использовать эти методы только с подпиской Джем.

Основная страница{{ /api/v2/search-report/report }}

Описание метода

Метод формирует набор данных для основной страницы отчёта по поисковым запросам с:

  • общей информацией
  • позициями товаров
  • данными по видимости и переходам в карточку
  • данными для таблицы по группам

Для получения дополнительных данных в таблице используйте отдельный запрос для:

Дополнительный параметр выбора списка товаров в таблице:

  • positionCluster — средняя позиция в поиске
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIds
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

positionCluster
required
string (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
required
object (OrderBy)

Параметры сортировки

limit
required
integer <uint32> <= 1000

Количество групп товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "positionCluster": "all",
  • "orderBy": {
    },
  • "limit": 130,
  • "offset": 50
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Пагинация по группам{{ /api/v2/search-report/table/groups }}

Описание метода

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

Дополнительный параметр выбора списка товаров в таблице:

  • positionCluster — средняя позиция в поиске
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIds
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object (OrderByGrTe)

Параметры сортировки

positionCluster
required
string (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
limit
required
integer <uint32> <= 1000

Количество групп товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "limit": 130,
  • "offset": 50
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Пагинация по товарам в группе{{ /api/v2/search-report/table/details }}

Описание метода

Метод формирует дополнительные данные к основному отчёту с пагинацией по товарам в группе. Пагинация возможна вне зависимости от наличия фильтров.

Фильтры для пагинации по товарам в группе или без фильтров:

  • кортеж subjectId,brandName,tagId — фильтр для группы
  • nmIds — фильтр по карточке товара

Дополнительный параметр выбора списка товаров:

  • positionCluster — средняя позиция в поиске
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

subjectId
integer <int32>

ID предмета

brandName
string

Название товара

tagId
integer <int64>

ID ярлыка

nmIds
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список артикулов WB

required
object (OrderBy)

Параметры сортировки

positionCluster
required
string
Enum: "all" "firstHundred" "secondHundred" "below"

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
limit
required
integer <uint32> <= 1000

Количество товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "subjectId": 123,
  • "brandName": "Apple",
  • "tagId": 45,
  • "nmIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Поисковые запросы по товару{{ /api/v2/search-report/product/search-texts }}

Описание метода

Метод формирует топ поисковых запросов по товару.

Параметры выбора поисковых запросов:

  • limit — количество запросов, максимум 30
  • topOrderBy — способ выбора топа запросов
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
required
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список артикулов WB

topOrderBy
required
string
Enum: "openCard" "addToCart" "openToCart" "orders" "cartToOrder"

Сортировка по полю:

  • openCard — перешли в карточку из поиска
  • addToCart — добавили в корзину из поиска
  • openToCart — конверсия в корзину из поиска
  • orders — заказали товаров из поиска
  • cartToOrder — конверсия в заказ из поиска
required
object (OrderByGrTe)

Параметры сортировки

limit
required
integer <uint64> (TextLimit) [ 1 .. 30 ]

Количество поисковых запросов по товару

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "topOrderBy": "openToCart",
  • "orderBy": {
    },
  • "limit": 20
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Заказы и позиции по поисковым запросам товара{{ /api/v2/search-report/product/orders }}

Описание метода

Метод формирует данные для таблицы по количеству заказов и позиций в поиске по запросам покупателя. Данные указаны в рамках периода для запрошенного товара.

Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (PeriodOrdersRequest)

Текущий период. Максимум 7 суток

nmId
required
integer <uint64>

Артикул WB

searchTexts
required
Array of strings [ 1 .. 30 ] items

Поисковые запросы

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "nmId": 211131895,
  • "searchTexts": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

История остатков

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике истории остатков можно в справочном центре

Это информация из детализированной таблицы товаров и виджета детализации по регионам.

Остатки в данной версии методов — на текущий день.

Методы получения отчёта по истории остатков:

  1. Данных по таблице товаров с агрегацией по группам, товарам, размерам
  2. Данных виджета Статистика по регионам отгрузки с детализацией по складам

Данные по группам{{ /api/v2/stocks-report/products/groups }}

Описание метода

Метод формирует набор данных об остатках по группам товаров.

Группа товаров описывается кортежем subjectID, brandName, tagID.

Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectIDs
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIDs
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады Маркетплейс (FBS)
skipDeletedNm
required
boolean

Скрыть удалённые товары

availabilityFilters
required
Array of strings (AvailabilityFilters)
Items Enum: "deficient" "actual" "balanced" "nonActual" "nonLiquid" "invalidData"

Доступность товара:

  • deficient — Дефицит
  • actual — Актуальный
  • balanced — Баланс
  • nonActual — Неактуальный
  • nonLiquid — Неликвид
  • invalidData — Не рассчитано
required
object (TableOrderBy)

Вид сортировки данных

limit
integer <uint32> <= 1000
Default: 100

Количество групп в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "availabilityFilters": [
    ],
  • "orderBy": {
    },
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Данные по товарам{{ /api/v2/stocks-report/products/products }}

Описание метода

Метод формирует набор данных об остатках по товарам.

Можно получить данные как по отдельным товарам, так и в рамках всего отчёта — если в запросе отсутствуют фильтры: nmIDs, subjectID, brandName, tagID.

Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectID
integer <int32>

ID предмета

brandName
string

Бренд

tagID
integer <int64>

ID ярлыка

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады Маркетплейс (FBS)
skipDeletedNm
required
boolean

Скрыть удалённые товары

required
object (TableOrderBy)

Вид сортировки данных

availabilityFilters
Array of strings (AvailabilityFilters)
Items Enum: "deficient" "actual" "balanced" "nonActual" "nonLiquid" "invalidData"

Доступность товара:

  • deficient — Дефицит
  • actual — Актуальный
  • balanced — Баланс
  • nonActual — Неактуальный
  • nonLiquid — Неликвид
  • invalidData — Не рассчитано
limit
integer <uint32> <= 1000
Default: 100

Количество товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectID": 123456,
  • "brandName": "Спортик",
  • "tagID": 25345,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "orderBy": {
    },
  • "availabilityFilters": [
    ],
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Данные по размерам{{ /api/v2/stocks-report/products/sizes }}

Описание метода

Метод формирует набор данных об остатках по размерам товара.

Возможны случаи:

  1. Товар имеет размеры и "includeOffice":true, тогда в ответе будут данные об остатках по каждому из размеров с вложенной детализацией по складам.
  2. Товар имеет размеры и "includeOffice":false, тогда в ответе будут данные об остатках по каждому из размеров без вложенной детализации по складам.
  3. Товар не имеет размера и "includeOffice":true, тогда в ответе будет детализация по складам. Без данных об остатках по каждому из размеров.
  4. Товар не имеет размера и "includeOffice":false, тогда тело ответа будет пустым.

    Товар не имеет размера, если у него единственный размер с "techSize":"0". В ответах метода получения данных по товарам у таких товаров "hasSizes":false.

    Данные по складам Маркетплейс (FBS) приходят в агрегированном виде — по всем сразу, без детализации по конкретным складам — эти записи будут с "regionName":"Маркетплейс" и "officeName":"".
Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmID
required
integer <int64>

Артикул WB

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады Маркетплейс (FBS)
required
object (TableOrderBy)

Вид сортировки данных

includeOffice
required
boolean

Включить детализацию по складам

Responses

Request samples

Content type
application/json
{
  • "nmID": 123456789,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "orderBy": {
    },
  • "includeOffice": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Данные по складам{{ /api/v2/stocks-report/offices }}

Описание метода

Метод формирует набор данных об остатках по складам.

Данные по складам Маркетплейс (FBS) приходят в агрегированном виде — по всем сразу, без детализации по конкретным складам — эти записи будут с "regionName":"Маркетплейс" и "offices":[].

Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectIDs
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIDs
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады Маркетплейс (FBS)
skipDeletedNm
required
boolean

Скрыть удалённые товары

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Аналитика продавца CSV

Для доступа к методам используйте токен для категории Аналитика

Чтобы получить отчёт:

  1. Сгенерируйте его с помощью метода метода создания отчёта.
  2. Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности через получение списка отчётов. Готовый отчёт хранится 48 часов.
    Если вы получили статус FAILED, сгенерируйте отчёт повторно.
  3. Получите отчёт.

Можно получить отчёт максимум за год.

Максимальное количество отчётов, генерируемых в сутки — 20.

Вы можете использовать эти методы — за исключением отчёта по истории остатков — только с подпиской Джем.

Создать отчёт{{ /api/v2/nm-report/downloads }}

Описание метода

Метод создаёт задание на генерацию отчёта с расширенной аналитикой продавца.

Вы можете создать CSV-версии отчётов по воронке продаж или параметрам поиска с группировкой по:

  • артикулам WB
  • предметам, брендам и ярлыкам

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

Также можете создать CSV-версии отчётов по текстам поисковых запросов и истории остатков.

Если не удалось получить отчёт, можно создать повторное задание на генерацию. Также можно получить список и проверить статусы отчётов.

Отчёт по истории остатков — модель StocksReportReq — можно создать без подписки Джем
Максимум 3 запроса в минуту на один аккаунт продавца, при этом в сутки можно сгенерировать максимум 20 отчётов (считаются только успешные генерации)
Authorizations:
HeaderApiKey
Request Body schema: application/json
One of
id
required
string <uuid>

ID отчёта в UUID-формате. Генерируется продавцом самостоятельно

reportType
required
string

Тип отчёта — DETAIL_HISTORY_REPORT

userReportName
string

Название отчёта. Если не указано, сформируется автоматически

required
object

Параметры отчёта

Responses

Request samples

Content type
application/json
Example

Воронка продаж. По артикулам WB

{
  • "id": "06eae887-9d9f-491f-b16a-bb1766fcb8d2",
  • "reportType": "DETAIL_HISTORY_REPORT",
  • "userReportName": "Card report",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "data": "Created"
}

Получить список отчётов{{ /api/v2/nm-report/downloads }}

Описание метода

Метод предоставляет список отчётов с расширенной аналитикой продавца. Ответ содержит ID созданных отчётов и статусы генерации.

Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
filter[downloadIds]
Array of strings <uuid> [ items <uuid > ]

ID отчёта

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Сгенерировать отчёт повторно{{ /api/v2/nm-report/downloads/retry }}

Описание метода

Метод создает повторное задание на генерацию отчёта с расширенной аналитикой продавца. Необходимо, если при генерации отчёта вы получили статус FAILED.

Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
downloadId
string <uuid>

ID отчёта

Responses

Request samples

Content type
application/json
{
  • "downloadId": "06eea887-9d9f-491f-b16a-bb1766fcb8d2"
}

Response samples

Content type
application/json
{
  • "data": "Retry"
}

Получить отчёт{{ /api/v2/nm-report/downloads/file/{downloadId} }}

Описание метода

Метод предоставляет отчёт с расширенной аналитикой продавца по ID задания на генерацию.

Можно получить отчёт, который сгенерирован за последние 48 часов.
Отчёт будет загружен внутри архива ZIP в формате CSV.

Максимум 3 запроса в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
downloadId
required
string <uuid>

ID отчёта

Responses

Response samples

Content type
text/csv
Example
nmID, dt, openCardCount, addToCartCount, ordersCount, ordersSumRub, buyoutsCount, buyoutsSumRub, cancelCount, cancelSumRub, addToCartConversion, cartToOrderConversion, buyoutPercent
70027655,2024-11-21,1,0,0,0,0,0,0,0,0,0,0
...
...
150317666,2024-11-21,2,0,0,0,0,0,0,0,0,0,0