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

POST /api/v2/search-report/table/groups

База: https://seller-analytics-api.wildberries.ru · Модуль: analytics · Раздел: Поисковые запросы по вашим товарам · Документация спецификации ↗

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

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

• positionCluster — средняя позиция в поиске Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:

Тип	Период	Лимит	Интервал	Всплеск
Персональный	1 мин	3 запроса	20 сек	3 запроса
Сервисный	1 мин	3 запроса	20 сек	3 запроса
Базовый с секретом	1 мин	3 запроса	20 сек	3 запроса
Базовый	1 ч	1 запрос	1 ч	1 запрос

Тело запроса

application/json — схема TableGroupRequest, обязательно

• currentPeriod Period (обязательно)
  • start string (обязательно) — Дата начала периода. Не позднее end. Не ранее 365 суток от сегодня
  • end string (обязательно) — Дата окончания периода. Не ранее 365 суток от сегодня
• pastPeriod pastPeriod
  • start string (обязательно) — Дата начала периода. Не позднее end. Не ранее 365 суток от сегодня
  • end string (обязательно) — Дата окончания периода. Не позднее даты перед датой начала currentPeriod. Не ранее 365 суток от сегодня
• nmIds integer<int32>[] — Список артикулов WB для фильтрации
• subjectIds integer<int32>[] — Список ID предметов для фильтрации
• brandNames string[] — Список брендов для фильтрации
• tagIds integer<int64>[] — Список ID ярлыков для фильтрации
• orderBy OrderByGrTe (обязательно)
  • field string = avgPosition | openCard | addToCart | openToCart | orders | cartToOrder | visibility (обязательно) — Поле для сортировки: - avgPosition — по средней позиции - addToCart — по добавлениям в корзину - openCard — по открытию карточки (переход на страницу товара) - orders — по количеству заказов - cartToOrder — по конверсии в заказ из поиска - openToCart — по конверсии в корзину из поиска - visibility — по видимости товара
  • mode string = asc | desc (обязательно) — Порядок сортировки: - asc — по возрастанию - desc — по убыванию
• positionCluster PositionCluster (обязательно)
• includeSubstitutedSKUs boolean — Показать данные по прямым запросам с подменным артикулом
• includeSearchTexts boolean — Показать данные по поисковым запросам без учёта подменного артикула
• limit integer<int64> (обязательно) — Количество групп товаров в ответе
• offset integer<int64> (обязательно) — После какого элемента выдавать данные

Ответы

Код	Описание	Схема
200	Успешно	PostV2SearchReportTableGroupsResponse200
400	Неправильный запрос	ErrorObject400
401	Не авторизован	object
402	Требуется платёж	object
403	Доступ запрещён	ErrorObject403
429	Слишком много запросов	object

Структура 200:

• data TableGroupResponse
  • groups TableGroupItem[] — Список групп товаров для таблицы
    • subjectName string — Название предмета
    • subjectId integer<int64> — ID предмета
    • brandName string — Бренд
    • tagName string — Название ярлыка
    • tagId integer<int64> — ID ярлыка
    • metrics object — Метрики товара в таблице
      • avgPosition object — Средняя позиция товара в результатах поиска
        • current integer<int64> — Текущая средняя позиция
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • openCard object — Количество переходов в карточку товара из поиска
        • current integer<int64> — Текущее количество переходов
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • addToCart object — Сколько раз товар из поиска добавили в корзину
        • current integer<int64> — Текущее количество
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • openToCart object — Конверсия в корзину из поиска — доля добавлений товара в корзину по отношению ко всем переходам в карточку товара из поиска
        • current integer<int64> — Текущая конверсия
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • orders object — Сколько раз товары из поиска заказали
        • current integer<int64> — Текущее количество
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • cartToOrder object — Конверсия в заказ из поиска — доля заказов товара по отношению ко всем добавлениям товара из поиска в корзину
        • current integer<int64> — Текущая конверсия
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • visibility object — Процент видимости товара в результатах поиска
        • current integer<int64> — Текущий процент видимости
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
    • items TableItem[] — Массив товаров группы
      • nmId integer<int64> — Артикул WB
      • name string — Название товара
      • vendorCode string — Артикул продавца
      • subjectName string — Название предмета
      • brandName string — Бренд
      • mainPhoto string — URL главного фото карточки товара
      • isAdvertised boolean — Находится ли товар в продвижении в Поисковой выдаче
      • isSubstitutedSKU boolean — Искали ли товар по подменному артикулу. Поле будет в ответе при наличии в запросе includeSubstitutedSKUs и/или includeSearchTexts
      • isCardRated boolean — Есть ли рейтинг у карточки товара
      • rating number<float64> — Рейтинг карточки товара
      • feedbackRating number<float64> — Рейтинг по отзывам
      • price object — Цена
        • minPrice integer<int64> — Минимальная цена продавца со скидкой продавца (без учёта скидки WB Клуба)
        • maxPrice integer<int64> — Максимальная цена продавца со скидкой продавца (без учёта скидки WB Клуба)
      • avgPosition object — Средняя позиция товара в результатах поиска
        • current integer<int64> — Текущая средняя позиция
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • openCard object — Количество переходов в карточку товара из поиска
        • current integer<int64> — Текущее количество переходов
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • addToCart object — Сколько раз товар из поиска добавили в корзину
        • current integer<int64> — Текущее количество
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • openToCart object — Конверсия в корзину из поиска — доля добавлений товара в корзину по отношению ко всем переходам в карточку товара из поиска
        • current integer<int64> — Текущая конверсия
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • orders object — Сколько раз товары из поиска заказали
        • current integer<int64> — Текущее количество
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • cartToOrder object — Конверсия в заказ из поиска — доля заказов товара по отношению ко всем добавлениям товара из поиска в корзину
        • current integer<int64> — Текущая конверсия
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
      • visibility object — Процент видимости товара в результатах поиска
        • current integer<int64> — Текущий процент видимости
        • dynamics integer<int64> — Динамика по сравнению с предыдущим периодом, %
  • currency Currency

Структура 400:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB

Структура 401:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• code string — Внутренний код ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB
• status number — HTTP статус-код
• statusText string — Расшифровка HTTP статус-кода
• timestamp string — Дата и время запроса

Структура 402:

• title string — Заголовок ошибки
• detail string — Детали ошибки. Ошибка возвращается только сервисам из Каталога решений для бизнеса

Структура 403:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB

Структура 429:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• code string — Внутренний код ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB
• status number — HTTP статус-код
• statusText string — Расшифровка HTTP статус-кода
• timestamp string — Дата и время запроса

Примеры вызова

Аргументы показаны именами параметров — подставьте свои значения. Языки, в клиенте которых этой операции нет, не показаны.

Python

from wb_api_client.analytics import Configuration, ApiClient
from wb_api_client.analytics.api import AnalyticsApi

cfg = Configuration(access_token="<ваш JWT WB>")
api = AnalyticsApi(ApiClient(cfg))

result = api.post_v2_search_report_table_groups(table_group_request=...)
print(result)

TypeScript

import {
  Configuration,
  AnalyticsApi,
} from "@valeryverkhoturov/wb-api-client/analytics";

const cfg = new Configuration({});
cfg.setAccessToken("<ваш JWT WB>");
const api = new AnalyticsApi(cfg);

const { data } = await api.postV2SearchReportTableGroups(tableGroupRequest);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbanalytics "github.com/ValeryVerkhoturov/wb-api-client-go/analytics"
)

cfg := wbanalytics.NewConfiguration()
cfg.SetAccessToken("<ваш JWT WB>")
client := wbanalytics.NewAPIClient(cfg)

result, _, err := client.AnalyticsAPI.PostV2SearchReportTableGroups(context.Background()).TableGroupRequest(tableGroupRequest).Execute()
if err != nil {
    panic(err)
}
fmt.Printf("%+v\n", result)

Java

import io.github.valeryverkhoturov.wbapi.analytics.ApiClient;
import io.github.valeryverkhoturov.wbapi.analytics.SecretString;
import io.github.valeryverkhoturov.wbapi.analytics.api.AnalyticsApi;

ApiClient client = new ApiClient();
client.setAccessToken(new SecretString("<ваш JWT WB>"));
AnalyticsApi api = new AnalyticsApi(client);

System.out.println(api.postV2SearchReportTableGroups(tableGroupRequest));

PHP

use ValeryVerkhoturov\WbApiClient\Analytics\Configuration;
use ValeryVerkhoturov\WbApiClient\Analytics\SecretString;
use ValeryVerkhoturov\WbApiClient\Analytics\Api\AnalyticsApi;
use GuzzleHttp\Client;

$config = (new Configuration())
    ->setAccessTokenSecret(new SecretString('<ваш JWT WB>'));
$api = new AnalyticsApi(new Client(), $config);

print_r($api->postV2SearchReportTableGroups($table_group_request));

OneScript

#Использовать "wb-api-client"

Настройки = Новый Конфигурация();
Настройки.УстановитьТокен("<ваш JWT WB>");
Клиент = Новый AnalyticsApi(Настройки);

Сообщить(Клиент.PostV2SearchReportTableGroups(Тело).Тело);

C#

using ValeryVerkhoturov.WbApiClient.Analytics.Api;
using ValeryVerkhoturov.WbApiClient.Analytics.Client;

var config = new Configuration();
config.AccessTokenSecret = new SecretString("<ваш JWT WB>");
var api = new AnalyticsApi(config);

Console.WriteLine(api.PostV2SearchReportTableGroups(tableGroupRequest));

Rust

use wb_api_client::analytics::apis::{configuration::Configuration, analytics_api};

#[tokio::main]
async fn main() {
    let mut cfg = Configuration::new();
    cfg.set_access_token("<ваш JWT WB>");

    let result = analytics_api::post_v2_search_report_table_groups(&cfg, table_group_request).await;
    println!("{:#?}", result);
}