Search Clusters Statistics

POST /adv/v0/normquery/stats

Base URL: https://advert-api.wildberries.ru · Module: promotion · Section: Statistics · Specification doc ↗

The method returns statistics for search clusters over a specified period. You can use this method only for campaigns with a cpm payment model — for impressions.

Request limit per one seller account:

Type	Period	Limit	Interval	Burst
Personal	1 min	10 requests	6 s	20 requests
Service	1 min	10 requests	6 s	20 requests
Base with secret	1 min	10 requests	6 s	20 requests
Base	1 h	5 requests	12 min	1 request

Request body

application/json — schema V0GetNormQueryStatsRequest, required

• from string (required) — Period start date
• to string (required) — Period end date
• items object[] (required)
  • advert_id integer<int64> (required) — Campaign ID
  • nm_id integer<int64> (required) — WB item number

Responses

Code	Description	Schema
200	Success	V0GetNormQueryStatsResponse
400	Bad request	response400
401	Unauthorized	object
403	Access denied	StandardizedBatchError
429	Too many requests	object

Structure 200:

• stats V0GetNormQueryStatsItem[]
  • advert_id integer<int64> — Campaign ID
  • nm_id integer<int64> — WB item number
  • stats V0GetNormQueryStatsItemStat[]
    • norm_query string — Search cluster
    • views integer<int64> — Number of views. For cpc campaigns (pay-per-click), the value will be null
    • clicks integer<int64> — Number of clicks
    • atbs integer<int64> — Number of items added to the basket
    • orders integer<int64> — Orders number
    • ctr number<double> — Click-through rate — the ratio of clicks to impressions, %. For cpc campaigns (pay-per-click), the value will be null
    • cpc number<double> — Cost per click in the base units of the seller account currency
    • cpm number<double> — Average cost per mille in the base units of the seller account currency. For cpc campaigns — pay-per-click, the value will be null
    • avg_pos number<double> — Average item position on search results pages
    • shks integer<int64> — Number of ordered items, pcs
    • spend number<double> — Item promotion costs in a specific search cluster of the campaign
    • currency string<ISO 4217> — Currency of the seller account currency

Structure 400:

• detail string — Error details
• origin string — WB internal service ID
• request_id string — Unique request ID
• status integer<int64> — HTTP status code
• title string — Error title

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 403:

• detail string — Error details
• origin string — WB internal service ID
• request_id string — Unique request ID
• status integer<int64> — HTTP Status Code
• title string — Error title

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.promotion import Configuration, ApiClient
from wb_api_client.promotion.api import PromotionApi

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

result = api.post_v0_normquery_stats(v0_get_norm_query_stats_request=...)
print(result)

TypeScript

import {
  Configuration,
  PromotionApi,
} from "@valeryverkhoturov/wb-api-client/promotion";

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

const { data } = await api.postV0NormqueryStats(v0GetNormQueryStatsRequest);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbpromotion "github.com/ValeryVerkhoturov/wb-api-client-go/promotion"
)

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

result, _, err := client.PromotionAPI.PostV0NormqueryStats(context.Background()).V0GetNormQueryStatsRequest(v0GetNormQueryStatsRequest).Execute()
if err != nil {
    panic(err)
}
fmt.Printf("%+v\n", result)

Java

import io.github.valeryverkhoturov.wbapi.promotion.ApiClient;
import io.github.valeryverkhoturov.wbapi.promotion.SecretString;
import io.github.valeryverkhoturov.wbapi.promotion.api.PromotionApi;

ApiClient client = new ApiClient();
client.setAccessToken(new SecretString("<your WB JWT>"));
PromotionApi api = new PromotionApi(client);

System.out.println(api.postV0NormqueryStats(v0GetNormQueryStatsRequest));

PHP

use ValeryVerkhoturov\WbApiClient\Promotion\Configuration;
use ValeryVerkhoturov\WbApiClient\Promotion\SecretString;
use ValeryVerkhoturov\WbApiClient\Promotion\Api\PromotionApi;
use GuzzleHttp\Client;

$config = (new Configuration())
    ->setAccessTokenSecret(new SecretString('<your WB JWT>'));
$api = new PromotionApi(new Client(), $config);

print_r($api->postV0NormqueryStats($v0_get_norm_query_stats_request));

OneScript

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

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

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

C#

using ValeryVerkhoturov.WbApiClient.Promotion.Api;
using ValeryVerkhoturov.WbApiClient.Promotion.Client;

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

Console.WriteLine(api.PostV0NormqueryStats(v0GetNormQueryStatsRequest));

Rust

use wb_api_client::promotion::apis::{configuration::Configuration, promotion_api};

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

    let result = promotion_api::post_v0_normquery_stats(&cfg, v0_get_norm_query_stats_request).await;
    println!("{:#?}", result);
}