Pagination by Items Within a Group

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

Base URL: https://seller-analytics-api.wildberries.ru · Module: analytics · Section: Search Queries for Your Items · Specification doc ↗

Pagination by items within a group. It is possible regardless of the presence of filters. Filters for pagination by items within a group or without filters:

• tuple subjectId, brandName, tagId — filter for the group
• nmIds — filter by listings Additional parameters for selecting the list of items in the table:
• positionCluster — average position in search The parameters includeSubstitutedSKUs and includeSearchTexts cannot both be set to false.

The report data is updated once every 2 hours.

Request limit per one seller account:

Type	Period	Limit	Interval	Burst
Personal	1 min	3 requests	20 s	3 requests
Service	1 min	3 requests	20 s	3 requests
Base with secret	1 min	3 requests	20 s	3 requests
Base	1 h	1 request	1 h	1 request

Request body

application/json — schema TableDetailsRequest, required

• currentPeriod Period (required)
  • start string (required) — Start date of the period. No later than end. No earlier than 365 days from today
  • end string (required) — End date of the period. No earlier than 365 days from today
• pastPeriod pastPeriod
  • start string (required) — Start date of the period. No later than end. No earlier than 365 days from today
  • end string (required) — End date of the period. No later than the day before the start date currentPeriod. No earlier than 365 days from today
• subjectId integer<int32> — Subcategory ID
• brandName string — Item name
• tagId integer<int64> — Label ID
• nmIds integer<int64>[] — WB item numbers list
• orderBy OrderByMainAndDetails (required)
  • field string = avgPosition | openCard | addToCart | openToCart | orders | cartToOrder | visibility | minPrice | maxPrice (required) — Field for sorting: - avgPosition — by average position - addToCart — by adds-to-Cart - openCard — by click-throughs - orders — by number of items ordered - cartToOrder — by conversion to order from search - openToCart — by conversion to cart from search - visibility — by item visibility - minPrice — by minimum price - maxPrice — by maximum price
  • mode string = asc | desc (required) — Order of sorting: - asc — ascending - desc — descending
• positionCluster string = all | firstHundred | secondHundred | below (required) — Which average search position of items to display in the report: - all — all - firstHundred — from 1 to 100 - secondHundred — from 101 to 200 - below — from 201 and below
• includeSubstitutedSKUs boolean — Show data for direct queries with promo items
• includeSearchTexts boolean — Show data for search queries without promo items
• limit integer<int64> (required) — Number of items in the response
• offset integer<int64> (required) — From which element to start outputting data

Responses

Code	Description	Schema
200	Success	PostV2SearchReportTableDetailsResponse200
400	Bad request	ErrorObject400
401	Unauthorized	object
402	Payment required	object
403	Access denied	ErrorObject403
429	Too many requests	object

Structure 200:

• data TableDetailsResponse
  • products TableItem[] — List of items in a group by filter
    • nmId integer<int64> — WB item number
    • name string — Item name
    • vendorCode string — Seller item number
    • subjectName string — Subcategory name
    • brandName string — Brand
    • mainPhoto string — URL of the main photo of the listing
    • isAdvertised boolean — Is the item being promoted in search results
    • isSubstitutedSKU boolean — If the item was searched by the promo item. The field will be in the response if the request contains includeSubstitutedSKUs and/or includeSearchTexts
    • isCardRated boolean — If the listing has a rating
    • rating number<float64> — Listing rating
    • feedbackRating number<float64> — Feedbacks rating
    • price object — Price
      • minPrice integer<int64> — Minimal price
      • maxPrice integer<int64> — Maximal price
    • avgPosition object — Average item position in search results
      • current integer<int64> — Current average position
      • dynamics integer<int64> — Dynamics compared to the previous period (%)
    • openCard object — Click-throughs from search
      • current integer<int64> — Current click-throughs
      • dynamics integer<int64> — Dynamics compared to the previous period (%)
    • addToCart object — Adds-to-Cart from search
      • current integer<int64> — Current number
      • dynamics integer<int64> — Dynamics compared to the previous period (%)
    • openToCart object — Conversion to cart from search — the ratio of item additions to the cart compared to all transitions to the listing from the search
      • current integer<int64> — Current conversion
      • dynamics integer<int64> — Dynamics compared to the previous period (%)
    • orders object — Items ordered from search
      • current integer<int64> — Current number
      • dynamics integer<int64> — Dynamics compared to the previous period (%)
    • cartToOrder object — Conversion to order from search — the ratio of items ordered to all additions of the item from search to the cart
      • current integer<int64> — Current conversion
      • dynamics integer<int64> — Dynamics compared to the previous period (%)
    • visibility object — Item visibility percent in search results
      • current integer<int64> — Current visibility percent
      • dynamics integer<int64> — Dynamics compared to the previous period (%)
  • currency Currency

Structure 400:

• title string — Error title
• detail string — Error details
• requestId string — Unique request ID
• origin string — Internal WB service ID

Structure 401:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Structure 402:

• title string — Error title
• detail string — Error details. The error is only returned to services from the Solutions for business Catalog

Structure 403:

• title string — Error title
• detail string — Error details
• requestId string — Unique request ID
• origin string — Internal WB service ID

Structure 429:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Call examples

Arguments are shown as parameter names — substitute your own values. Languages whose client does not expose this operation are omitted.

Python

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

cfg = Configuration(access_token="<your WB JWT>")
api = AnalyticsApi(ApiClient(cfg))

result = api.post_v2_search_report_table_details(table_details_request=...)
print(result)

TypeScript

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

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

const { data } = await api.postV2SearchReportTableDetails(tableDetailsRequest);
console.log(data);

Go

import (
	"context"
	"fmt"

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

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

result, _, err := client.AnalyticsAPI.PostV2SearchReportTableDetails(context.Background()).TableDetailsRequest(tableDetailsRequest).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("<your WB JWT>"));
AnalyticsApi api = new AnalyticsApi(client);

System.out.println(api.postV2SearchReportTableDetails(tableDetailsRequest));

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('<your WB JWT>'));
$api = new AnalyticsApi(new Client(), $config);

print_r($api->postV2SearchReportTableDetails($table_details_request));

OneScript

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

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

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

C#

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

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

Console.WriteLine(api.PostV2SearchReportTableDetails(tableDetailsRequest));

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("<your WB JWT>");

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