/** * Документация Ozon Seller API * По вопросам работы с Seller API обращайтесь в поддержку через личный кабинет. > [Инструкции по работе с маркетплейсом](https://seller-edu.ozon.ru) > [Информационная платформа и сообщество разработчиков Ozon for dev](https://dev.ozon.ru/) * * The version of the OpenAPI document: 2.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { AnalyticsFilter } from './AnalyticsFilter'; import type { SellerServiceanalyticsDimension } from './SellerServiceanalyticsDimension'; import type { AnalyticsSorting } from './AnalyticsSorting'; /** * * @export * @interface AnalyticsAnalyticsGetDataRequest */ export interface AnalyticsAnalyticsGetDataRequest { /** * Дата, с которой будут данные в отчёте. * * Если у вас нет Premium-подписки, укажите дату в пределах последних трёх месяцев. * * @type {string} * @memberof AnalyticsAnalyticsGetDataRequest */ date_from: string; /** * Дата, по которую будут данные в отчёте. * @type {string} * @memberof AnalyticsAnalyticsGetDataRequest */ date_to: string; /** * Группировка данных в отчёте. * * Способы группировки, доступные всем продавцам: * - `unknownDimension` — неизвестное измерение; * - `sku` — идентификатор товара; * - `spu` — идентификатор товара — объединённая карточка; * - `day` — день; * - `week` — неделя; * - `month` — месяц. * * Способы группировки, доступные только продавцам с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus): * - `year` — год; * - `category1` — категория первого уровня; * - `category2` — категория второго уровня; * - `brand` — бренд; * - `modelID` — модель; * - `descriptionType` — тип товара. * * @type {Array} * @memberof AnalyticsAnalyticsGetDataRequest */ dimension: Array; /** * Фильтры. * @type {Array} * @memberof AnalyticsAnalyticsGetDataRequest */ filters?: Array; /** * Количество значений в ответе: * - максимум — 1000, * - минимум — 1. * * @type {number} * @memberof AnalyticsAnalyticsGetDataRequest */ limit: number; /** * Укажите до 14 метрик. Если их будет больше, вы получите ошибку с кодом `InvalidArgument`. * * Список метриĸ, по ĸоторым будет сформирован отчёт. * * Метрики, доступные всем продавцам: * - `revenue` — заказано на сумму, * - `ordered_units` — заказано товаров. * * Метрики, доступные только продавцам с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus): * - `unknown_metric` — неизвестная метрика. * - `hits_view_search` — показы в поиске и в категории. * - `hits_view_pdp` — показы на карточке товара. * - `hits_view` — всего показов. * - `hits_tocart_search` — в корзину из поиска или категории. * - `hits_tocart_pdp` — в корзину из карточки товара. * - `hits_tocart` — всего добавлено в корзину. * - `session_view_search` — сессии с показом в поиске или в каталоге. Считаются уникальные посетители с просмотром в поиске или каталоге. * - `session_view_pdp` — сессии с показом на карточке товара. Считаются уникальные посетители, которые просмотрели карточку товара. * - `session_view` — всего сессий. Считаются уникальные посетители. * - `conv_tocart_search` — конверсия в корзину из поиска или категории. * - `conv_tocart_pdp` — конверсия в корзину из карточки товара. * - `conv_tocart` — общая конверсия в корзину. * - `returns` — возвращено товаров. * - `cancellations` — отменено товаров. * - `delivered_units` — доставлено товаров. * - `position_category` — позиция в поиске и категории. * * @type {Array} * @memberof AnalyticsAnalyticsGetDataRequest */ metrics: Array; /** * Количество элементов, которое будет пропущено в ответе. Например, если `offset = 10`, то ответ начнётся с 11-го найденного элемента. * @type {number} * @memberof AnalyticsAnalyticsGetDataRequest */ offset?: number; /** * Настройки сортировки отчёта. * @type {Array} * @memberof AnalyticsAnalyticsGetDataRequest */ sort?: Array; } /** * Check if a given object implements the AnalyticsAnalyticsGetDataRequest interface. */ export declare function instanceOfAnalyticsAnalyticsGetDataRequest(value: object): value is AnalyticsAnalyticsGetDataRequest; export declare function AnalyticsAnalyticsGetDataRequestFromJSON(json: any): AnalyticsAnalyticsGetDataRequest; export declare function AnalyticsAnalyticsGetDataRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnalyticsAnalyticsGetDataRequest; export declare function AnalyticsAnalyticsGetDataRequestToJSON(value?: AnalyticsAnalyticsGetDataRequest | null): any;