import { BaseClient } from '../../client/base-client'; import { CommonResponseProperties, MainRequest, MainResponse, NmReportCreateReportResponse, NmReportGetReportsResponse, NmReportRetryReportRequest, NmReportRetryReportResponse, ProductOrdersRequest, ProductOrdersResponse, ProductSearchTextsRequest, ProductSearchTextsResponse, SalesFunnelGroupReq, SalesFunnelProductReq, SalesFunnelProductsRequest, SalesFunnelProductsResponse, SalesFunnelProductsHistoryRequest, SalesFunnelProductsHistoryResponse, SalesFunnelGroupedHistoryRequest, SalesFunnelGroupedHistoryResponse, SearchReportGroupReq, SearchReportProductReq, SearchReportTextReq, StocksReportReq, TableDetailsRequest, TableDetailsResponse, TableGroupRequest, TableGroupRequestSt, TableGroupResponse, TableGroupResponseSt, TableProductRequest, TableProductResponse, TableShippingOfficeRequest, TableShippingOfficeResponse, TableSizeRequest, TableSizeResponse, WbWarehousesStockRequest, WbWarehousesStockResponse } from '../../types/analytics.types'; export declare class AnalyticsModule { private client; constructor(client: BaseClient); /** * Получить список отчётов * * Метод возвращает список отчётов с расширенной аналитикой продавца. Ответ содержит ID созданных отчётов и статусы генерации. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param [options] - Query parameters * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV} * @example * const result = await sdk.analytics.getNmReportDownloads({}); * console.log(result); */ getNmReportDownloads(options?: { 'filter[downloadIds]'?: string[]; }): Promise; /** * Создать отчёт * * Метод создаёт задание на генерацию отчёта с расширенной аналитикой продавца. * Вы можете создать CSV-версии отчётов по воронке продаж или параметрам поиска с группировкой по артикулам WB, предметам, брендам и ярлыкам. * В отчётах по воронке продаж можно группировать данные по дням, неделям или месяцам. * Параметры `includeSubstitutedSKUs` и `includeSearchTexts` не могут одновременно иметь значение `false`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @remarks Daily limit: 20 reports per day per seller account. * @param [data] - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV} * @example * const result = await sdk.analytics.createNmReportDownload({}); * console.log(result); */ createNmReportDownload(data?: SalesFunnelProductReq | SalesFunnelGroupReq | SearchReportGroupReq | SearchReportProductReq | SearchReportTextReq | StocksReportReq): Promise; /** * Сгенерировать отчёт повторно * * Метод создает повторное задание на генерацию отчёта с расширенной аналитикой продавца. * Необходимо, если при генерации отчёта вы получили статус `FAILED`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV} * @example * const result = await sdk.analytics.createDownloadsRetry({}); * console.log(result); */ createDownloadsRetry(data: NmReportRetryReportRequest): Promise; /** * Получить отчёт * * Метод возвращает отчёт с расширенной аналитикой продавца по ID задания на генерацию. * Можно получить отчёт, который сгенерирован за последние 48 часов. * Отчёт будет загружен внутри архива ZIP в формате CSV. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param downloadId - ID отчёта (UUID format) * @returns Успешно - ZIP архив с CSV файлом * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Analitika-prodavca-CSV} * @example * const result = await sdk.analytics.getDownloadsFile('downloadId-value'); * console.log(result); */ getDownloadsFile(downloadId: string): Promise; /** * Основная страница * * Метод формирует набор данных для основной страницы отчёта по поисковым запросам с общей информацией, позициями товаров, данными по видимости и переходам в карточку, данными для таблицы по группам. * Параметры `includeSubstitutedSKUs` и `includeSearchTexts` не могут одновременно иметь значение `false`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy} * @example * const result = await sdk.analytics.createSearchReportReport({}); * console.log(result); */ createSearchReportReport(data: MainRequest): Promise; /** * Пагинация по группам * * Метод формирует дополнительные данные к основному отчёту с пагинацией по группам. * Пагинация возможна только при наличии фильтра по бренду, предмету или ярлыку. * Параметры `includeSubstitutedSKUs` и `includeSearchTexts` не могут одновременно иметь значение `false`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy} * @example * const result = await sdk.analytics.createTableGroup({}); * console.log(result); */ createTableGroup(data: TableGroupRequest): Promise; /** * Пагинация по товарам в группе * * Метод формирует дополнительные данные к основному отчёту с пагинацией по товарам в группе. * Пагинация возможна вне зависимости от наличия фильтров. * Параметры `includeSubstitutedSKUs` и `includeSearchTexts` не могут одновременно иметь значение `false`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy} * @example * const result = await sdk.analytics.createTableDetail({}); * console.log(result); */ createTableDetail(data: TableDetailsRequest): Promise; /** * Поисковые запросы по товару * * Метод формирует топ поисковых запросов по товару. * Параметры `includeSubstitutedSKUs` и `includeSearchTexts` не могут одновременно иметь значение `false`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy} * @example * const result = await sdk.analytics.createProductSearchText({}); * console.log(result); */ createProductSearchText(data: ProductSearchTextsRequest): Promise; /** * Заказы и позиции по поисковым запросам товара * * Метод формирует данные для таблицы по количеству заказов и позиций в поиске по запросам покупателя. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Poiskovye-zaprosy} * @example * const result = await sdk.analytics.createProductOrder({}); * console.log(result); */ createProductOrder(data: ProductOrdersRequest): Promise; /** * Данные по группам * * Метод формирует набор данных об остатках по группам товаров. * Группа товаров описывается кортежем `subjectID, brandName, tagID`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov} * @example * const result = await sdk.analytics.createProductsGroup({}); * console.log(result); */ createProductsGroup(data: TableGroupRequestSt): Promise<{ data: TableGroupResponseSt; }>; /** * Данные по товарам * * Метод формирует набор данных об остатках по товарам. * Можно получить данные как по отдельным товарам, так и в рамках всего отчёта — если в запросе отсутствуют фильтры: `nmIDs`, `subjectID`, `brandName`, `tagID`. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov} * @example * const result = await sdk.analytics.createProductsProduct({}); * console.log(result); */ createProductsProduct(data: TableProductRequest): Promise<{ data: TableProductResponse; }>; /** * Данные по размерам * * Метод формирует набор данных об остатках по размерам товара. * Товар не имеет размера, если у него единственный размер с `"techSize":"0"`. * Данные по складам Маркетплейс (FBS) приходят в агрегированном виде. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov} * @example * const result = await sdk.analytics.createProductsSize({}); * console.log(result); */ createProductsSize(data: TableSizeRequest): Promise<{ data: TableSizeResponse; }>; /** * Данные по складам * * Метод формирует набор данных об остатках по складам. * Данные по складам Маркетплейс (FBS) приходят в агрегированном виде — по всем сразу, без детализации по конкретным складам. * * Rate limit: 3 requests/minute, 20-second interval, burst 3 * * @param data - Request body data * @returns Успешно * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link https://dev.wildberries.ru/openapi/seller-analytics#tag/Istoriya-ostatkov} * @example * const result = await sdk.analytics.createStocksReportOffice({}); * console.log(result); */ createStocksReportOffice(data: TableShippingOfficeRequest): Promise<{ data: TableShippingOfficeResponse; }>; /** * Статистика карточек товаров за период (v3) * * Возвращает отчёт о товарах с ключевыми показателями — переходы в карточку, * добавления в корзину, заказы — за текущий и прошлый периоды. * * Rate limit: 3 requests/minute, 20-second interval, 3-request burst * * @param data - Request parameters * @returns Sales funnel products statistics * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link 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); */ getSalesFunnelProducts(data: SalesFunnelProductsRequest): Promise; /** * Статистика карточек товаров по дням (v3) * * Возвращает статистику карточек товаров по дням или неделям. * * Rate limit: 3 requests/minute, 20-second interval, 3-request burst * * @param data - Request parameters * @returns Products history statistics * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link 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); */ getSalesFunnelProductsHistory(data: SalesFunnelProductsHistoryRequest): Promise; /** * Статистика групп карточек товаров по дням (v3) * * Возвращает статистику карточек товаров по дням, сгруппированных по предметам, брендам и ярлыкам. * * Rate limit: 3 requests/minute, 20-second interval, 3-request burst * * @param data - Request parameters * @returns Grouped history statistics * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @see {@link 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); */ getSalesFunnelGroupedHistory(data: SalesFunnelGroupedHistoryRequest): Promise; /** * Текущие остатки на складах WB * * Возвращает актуальные остатки товаров на складах Wildberries. * Данные обновляются раз в 30 минут. Одна строка = один размер на одном складе. * Результаты отсортированы по возрастанию nmId. * * Доступен только для токенов типа Personal и Service. * * **Заменяет устаревший метод** `GET /api/v1/supplier/stocks`, * который будет отключён 23 июня 2026. * * Rate limit: 3 requests per minute, 20-second interval, burst 1 * * @param data - Filter and pagination parameters (all optional) * @param data.nmIds - WB articles to filter (0-1000, empty = all) * @param data.chrtIds - Size IDs (only for articles in nmIds) * @param data.limit - Rows in response (max 250000, default 250000) * @param data.offset - Skip N results for pagination (default 0) * @returns Current inventory with warehouse IDs, region names, quantities * @throws {AuthenticationError} When API key is invalid (401/403) * @throws {RateLimitError} When rate limit exceeded (429) * @throws {ValidationError} When request data is invalid (400/422) * @throws {NetworkError} When network request fails or times out * @since 3.4.0 * @see {@link https://dev.wildberries.ru/docs/openapi/analytics#tag/Istoriya-ostatkov/operation/postV1StocksReportWbWarehouses} * @example * ```typescript * // Get all inventory * const stock = await sdk.analytics.getWbWarehousesStock(); * for (const item of stock.data.items) { * console.log(`${item.warehouseName} (${item.regionName}): ${item.quantity} шт.`); * } * * // With filters and pagination * const page = await sdk.analytics.getWbWarehousesStock({ * nmIds: [395996251], * limit: 100, * offset: 0, * }); * ``` */ getWbWarehousesStock(data?: WbWarehousesStockRequest): Promise; } export type { MainRequest, MainResponse, CommonInfo, PositionInfo, SearchReportPositionChartItem, SearchReportPositionClusters, VisibilityInfo, TableGroupItem, TableProductItem, TableGroupRequest, TableGroupResponse, TableDetailsRequest, TableDetailsResponse, ProductSearchTextsRequest, ProductSearchTextsResponse, TableSearchTextItem, ProductOrdersRequest, ProductOrdersResponse, ProductOrdersTextItem, ProductOrdersMetrics, PositionCluster, OrderBy, OrderByMainAndDetails, OrderByGrTe, TextLimit, StandardTariff, AdvancedTariff, Date, PeriodOrdersRequest, Period, PastPeriod, CommonResponseProperties, ErrorObject400, ErrorObject403, ErrorObject, ResponseError, SalesFunnelProductReq, SalesFunnelGroupReq, SearchReportGroupReq, SearchReportProductReq, SearchReportTextReq, StocksReportReq, NmReportRetryReportRequest, NmReportCreateReportResponse, NmReportGetReportsResponse, NmReportRetryReportResponse, Response429Download, Response429DownloadDaily, TableGroupRequestSt, CommonReportFilters, PeriodSt, StockType, AvailabilityFilters, TableOrderBy, TableGroupField, OrderByMode, TableGroupResponseSt, TableGroups, TableGroupItemSt, TableCommonMetrics, FloatGraphByPeriodItem, TableProductItemSt, TableProductRequest, CommonProductFilters, TableProductResponse, TableSizeRequest, CommonSizeFilters, TableSizeResponse, TableOfficeItem, TableShippingOfficeRequest, CommonShippingOfficeFilters, TableShippingOfficeResponse, TableShippingOfficeItem, TableShippingOfficeMetrics, DatePeriod, AggregationLevel, SalesFunnelOrderBy, SalesFunnelTag, SalesFunnelTimeToReady, SalesFunnelConversions, SalesFunnelWbClubMetrics, SalesFunnelWbClubMetricsDynamic, SalesFunnelProductsRequest, SalesFunnelProductsHistoryRequest, SalesFunnelGroupedHistoryRequest, SalesFunnelProduct, SalesFunnelHistoryProduct, SalesFunnelStatistic, SalesFunnelComparison, SalesFunnelStatistics, SalesFunnelHistory, SalesFunnelProductsResponse, SalesFunnelProductsHistoryResponse, SalesFunnelGroupedHistoryResponse, WbWarehousesStockRequest, WbWarehouseStockItem, WbWarehousesStockResponse, } from '../../types/analytics.types'; //# sourceMappingURL=index.d.ts.map