Wildberries API TypeScript SDK / AnalyticsModule

Class: AnalyticsModule

Defined in: modules/analytics/index.ts:46

Constructors

Constructor

new AnalyticsModule(client: BaseClient): AnalyticsModule;

Defined in: modules/analytics/index.ts:47

Parameters

Parameter	Type
client	BaseClient

Returns

AnalyticsModule

Methods

getNmReportDownloads()

getNmReportDownloads(options?: {
  filter[downloadIds]?: string[];
}): Promise<NmReportGetReportsResponse>;

Defined in: modules/analytics/index.ts:67

Получить список отчётов

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
options?	{ filter[downloadIds]?: string[]; }	Query parameters
options.filter[downloadIds]?	string[]	-

Returns

Promise<NmReportGetReportsResponse>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV

Example

const result = await sdk.analytics.getNmReportDownloads({});
console.log(result);

---

createNmReportDownload()

createNmReportDownload(data?: 
  | SalesFunnelProductReq
  | SalesFunnelGroupReq
  | SearchReportGroupReq
  | SearchReportProductReq
  | SearchReportTextReq
| StocksReportReq): Promise<NmReportCreateReportResponse>;

Defined in: modules/analytics/index.ts:98

Создать отчёт

Метод создаёт задание на генерацию отчёта с расширенной аналитикой продавца. Вы можете создать CSV-версии отчётов по воронке продаж или параметрам поиска с группировкой по артикулам WB, предметам, брендам и ярлыкам. В отчётах по воронке продаж можно группировать данные по дням, неделям или месяцам. Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data?	| SalesFunnelProductReq | SalesFunnelGroupReq | SearchReportGroupReq | SearchReportProductReq | SearchReportTextReq | StocksReportReq	Request body data

Returns

Promise<NmReportCreateReportResponse>

Успешно

Remarks

Daily limit: 20 reports per day per seller account.

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV

Example

const result = await sdk.analytics.createNmReportDownload({});
console.log(result);

---

createDownloadsRetry()

createDownloadsRetry(data: NmReportRetryReportRequest): Promise<NmReportRetryReportResponse>;

Defined in: modules/analytics/index.ts:133

Сгенерировать отчёт повторно

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	NmReportRetryReportRequest	Request body data

Returns

Promise<NmReportRetryReportResponse>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV

Example

const result = await sdk.analytics.createDownloadsRetry({});
console.log(result);

---

getDownloadsFile()

getDownloadsFile(downloadId: string): Promise<ArrayBuffer>;

Defined in: modules/analytics/index.ts:163

Получить отчёт

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
downloadId	string	ID отчёта (UUID format)

Returns

Promise<ArrayBuffer>

Успешно - ZIP архив с CSV файлом

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV

Example

const result = await sdk.analytics.getDownloadsFile('downloadId-value');
console.log(result);

---

createSearchReportReport()

createSearchReportReport(data: MainRequest): Promise<CommonResponseProperties & {
  data: MainResponse;
}>;

Defined in: modules/analytics/index.ts:189

Основная страница

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	MainRequest	Request body data

Returns

Promise<CommonResponseProperties & { data: MainResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy

Example

const result = await sdk.analytics.createSearchReportReport({});
console.log(result);

---

createTableGroup()

createTableGroup(data: TableGroupRequest): Promise<CommonResponseProperties & {
  data: TableGroupResponse;
}>;

Defined in: modules/analytics/index.ts:219

Пагинация по группам

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	TableGroupRequest	Request body data

Returns

Promise<CommonResponseProperties & { data: TableGroupResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy

Example

const result = await sdk.analytics.createTableGroup({});
console.log(result);

---

createTableDetail()

createTableDetail(data: TableDetailsRequest): Promise<CommonResponseProperties & {
  data: TableDetailsResponse;
}>;

Defined in: modules/analytics/index.ts:249

Пагинация по товарам в группе

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	TableDetailsRequest	Request body data

Returns

Promise<CommonResponseProperties & { data: TableDetailsResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy

Example

const result = await sdk.analytics.createTableDetail({});
console.log(result);

---

createProductSearchText()

createProductSearchText(data: ProductSearchTextsRequest): Promise<CommonResponseProperties & {
  data: ProductSearchTextsResponse;
}>;

Defined in: modules/analytics/index.ts:278

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

Метод формирует топ поисковых запросов по товару. Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	ProductSearchTextsRequest	Request body data

Returns

Promise<CommonResponseProperties & { data: ProductSearchTextsResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy

Example

const result = await sdk.analytics.createProductSearchText({});
console.log(result);

---

createProductOrder()

createProductOrder(data: ProductOrdersRequest): Promise<CommonResponseProperties & {
  data: ProductOrdersResponse;
}>;

Defined in: modules/analytics/index.ts:306

Заказы и позиции по поисковым запросам товара

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	ProductOrdersRequest	Request body data

Returns

Promise<CommonResponseProperties & { data: ProductOrdersResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy

Example

const result = await sdk.analytics.createProductOrder({});
console.log(result);

---

createProductsGroup()

createProductsGroup(data: TableGroupRequestSt): Promise<{
  data: TableGroupResponseSt;
}>;

Defined in: modules/analytics/index.ts:335

Данные по группам

Метод формирует набор данных об остатках по группам товаров. Группа товаров описывается кортежем subjectID, brandName, tagID.

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	TableGroupRequestSt	Request body data

Returns

Promise<{ data: TableGroupResponseSt; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov

Example

const result = await sdk.analytics.createProductsGroup({});
console.log(result);

---

createProductsProduct()

createProductsProduct(data: TableProductRequest): Promise<{
  data: TableProductResponse;
}>;

Defined in: modules/analytics/index.ts:362

Данные по товарам

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

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	TableProductRequest	Request body data

Returns

Promise<{ data: TableProductResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov

Example

const result = await sdk.analytics.createProductsProduct({});
console.log(result);

---

createProductsSize()

createProductsSize(data: CommonSizeFilters): Promise<{
  data: TableSizeResponse;
}>;

Defined in: modules/analytics/index.ts:390

Данные по размерам

Метод формирует набор данных об остатках по размерам товара. Товар не имеет размера, если у него единственный размер с "techSize":"0". Данные по складам Маркетплейс (FBS) приходят в агрегированном виде.

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	CommonSizeFilters	Request body data

Returns

Promise<{ data: TableSizeResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov

Example

const result = await sdk.analytics.createProductsSize({});
console.log(result);

---

createStocksReportOffice()

createStocksReportOffice(data: CommonShippingOfficeFilters): Promise<{
  data: TableShippingOfficeResponse;
}>;

Defined in: modules/analytics/index.ts:417

Данные по складам

Метод формирует набор данных об остатках по складам. Данные по складам Маркетплейс (FBS) приходят в агрегированном виде — по всем сразу, без детализации по конкретным складам.

Rate limit: 3 requests/minute, 20-second interval, burst 3

Parameters

Parameter	Type	Description
data	CommonShippingOfficeFilters	Request body data

Returns

Promise<{ data: TableShippingOfficeResponse; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov

Example

const result = await sdk.analytics.createStocksReportOffice({});
console.log(result);

---

getSalesFunnelProducts()

getSalesFunnelProducts(data: SalesFunnelProductsRequest): Promise<SalesFunnelProductsResponse>;

Defined in: modules/analytics/index.ts:453

Статистика карточек товаров за период (v3)

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

Rate limit: 3 requests/minute, 20-second interval, 3-request burst

Parameters

Parameter	Type	Description
data	SalesFunnelProductsRequest	Request parameters

Returns

Promise<SalesFunnelProductsResponse>

Sales funnel products statistics

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Voronka-prodazh

Example

const result = await sdk.analytics.getSalesFunnelProducts({
  selectedPeriod: { start: '2026-01-01', end: '2026-01-31' },
  orderBy: { field: 'orderCount', mode: 'desc' },
  limit: 10,
  offset: 0,
});
console.log(result.products);

---

getSalesFunnelProductsHistory()

getSalesFunnelProductsHistory(data: SalesFunnelProductsHistoryRequest): Promise<SalesFunnelProductsHistoryResponse>;

Defined in: modules/analytics/index.ts:485

Статистика карточек товаров по дням (v3)

Возвращает статистику карточек товаров по дням или неделям.

Rate limit: 3 requests/minute, 20-second interval, 3-request burst

Parameters

Parameter	Type	Description
data	SalesFunnelProductsHistoryRequest	Request parameters

Returns

Promise<SalesFunnelProductsHistoryResponse>

Products history statistics

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Voronka-prodazh

Example

const result = await sdk.analytics.getSalesFunnelProductsHistory({
  selectedPeriod: { start: '2026-01-01', end: '2026-01-07' },
  nmIds: [268913787],
  aggregationLevel: 'day',
});
console.log(result);

---

getSalesFunnelGroupedHistory()

getSalesFunnelGroupedHistory(data: SalesFunnelGroupedHistoryRequest): Promise<SalesFunnelGroupedHistoryResponse>;

Defined in: modules/analytics/index.ts:516

Статистика групп карточек товаров по дням (v3)

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

Rate limit: 3 requests/minute, 20-second interval, 3-request burst

Parameters

Parameter	Type	Description
data	SalesFunnelGroupedHistoryRequest	Request parameters

Returns

Promise<SalesFunnelGroupedHistoryResponse>

Grouped history statistics

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/seller-analytics#tag/Voronka-prodazh

Example

const result = await sdk.analytics.getSalesFunnelGroupedHistory({
  selectedPeriod: { start: '2026-01-01', end: '2026-01-07' },
  aggregationLevel: 'day',
});
console.log(result);