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

GET /api/v1/analytics/brand-share

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

Метод возвращает отчёт о доле бренда продавца в продажах.

Можно получить отчёт максимум за 365 дней. Данные доступны с 1 ноября 2022.

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

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

Параметры

Имя	Где	Тип	Обяз.	Описание
parentId	query	integer<int64>	да	ID родительской категории
brand	query	string	да	Бренд

Ответы

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

Структура 200:

• report object[] — Отчёт
  • applyDate string<ГГГГ-ММ-ДД> — Дата
  • brandRating integer<int64> — Рейтинг бренда в родительской категории
  • pricePercent number<float> — Доля от продаж в родительской категории — цена, %
  • qtyPercent number<float> — Доля от продаж в родительской категории — количество, %

Структура 400:

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

Структура 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 — Детали ошибки
• code string — Внутренний код ошибки
• requestId string — ID запроса
• origin string — ID внутреннего сервиса WB
• status number — HTTP статус-код
• statusText string — Расшифровка HTTP статус-кода
• timestamp string — Дата и время запроса

Структура 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.reports import Configuration, ApiClient
from wb_api_client.reports.api import ReportsApi

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

result = api.get_v1_analytics_brand_share(parent_id=..., brand=..., date_from=..., date_to=...)
print(result)

TypeScript

import {
  Configuration,
  ReportsApi,
} from "@valeryverkhoturov/wb-api-client/reports";

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

const { data } = await api.getV1AnalyticsBrandShare(parentId, brand, dateFrom, dateTo);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbreports "github.com/ValeryVerkhoturov/wb-api-client-go/reports"
)

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

result, _, err := client.ReportsAPI.GetV1AnalyticsBrandShare(context.Background()).ParentId(parentId).Brand(brand).Execute()
if err != nil {
    panic(err)
}
fmt.Printf("%+v\n", result)

Java

import io.github.valeryverkhoturov.wbapi.reports.ApiClient;
import io.github.valeryverkhoturov.wbapi.reports.SecretString;
import io.github.valeryverkhoturov.wbapi.reports.api.ReportsApi;

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

System.out.println(api.getV1AnalyticsBrandShare(parentId, brand, dateFrom, dateTo));

PHP

use ValeryVerkhoturov\WbApiClient\Reports\Configuration;
use ValeryVerkhoturov\WbApiClient\Reports\SecretString;
use ValeryVerkhoturov\WbApiClient\Reports\Api\ReportsApi;
use GuzzleHttp\Client;

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

print_r($api->getV1AnalyticsBrandShare($parent_id, $brand, $date_from, $date_to));

OneScript

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

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

Сообщить(Клиент.GetV1AnalyticsBrandShare(parentId, brand, dateFrom, dateTo).Тело);

C#

using ValeryVerkhoturov.WbApiClient.Reports.Api;
using ValeryVerkhoturov.WbApiClient.Reports.Client;

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

Console.WriteLine(api.GetV1AnalyticsBrandShare(parentId, brand, dateFrom, dateTo));

Rust

use wb_api_client::reports::apis::{configuration::Configuration, reports_api};

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

    let result = reports_api::get_v1_analytics_brand_share(&cfg, parent_id, brand, date_from, date_to).await;
    println!("{:#?}", result);
}