Товарная аналитика

Возвращает детальный срез показателей по товарам с фильтрацией, сортировкой и пагинацией.

POST/v1/analytics/reports/productsAPI Preview

Описание метода

Метод возвращает строки товарного отчёта, итоги по каждой позиции и процент изменения метрик между крайними точками периода.

Размер страницы в текущей реализации отчёта — 20 строк.
Режим объединения товаров выбирается через filters.product_merge_type.
Для выгрузки передайте export=true и один из поддерживаемых форматов.

АвторизацияBearer token

Периоддо 3 лет

ФорматJSON

Тело запроса

Content-Type: application/json

required

ПолеТипОбяз.Описание

project_iduuidДа

Идентификатор проекта, данные которого нужно получить.

period_startdateДа

Начало периода включительно в формате YYYY-MM-DD.

period_enddateДа

Конец периода включительно в формате YYYY-MM-DD.

aggregationenumДа

Шаг агрегации временных данных.

dailyweeklymonthly

pageenumНет

Контекст расчёта метрик.

dashboardproduct

По умолчанию: dashboard

metricsarray<object>Нет

Список метрик с полями id и name. Если не передан, используется набор отчёта.

filtersobjectНет

Фильтры по кабинетам, товарам, брендам, категориям, тегам и моделям доставки.

paginationintegerДа

Номер страницы, начиная с 1.

По умолчанию: 1

sort_metricstringДа

Идентификатор метрики для сортировки.

По умолчанию: sum_discounted_price

sort_directionenumДа

Направление сортировки.

ASCDESC

exportbooleanНет

Вернуть файл вместо JSON-структуры.

По умолчанию: false

formatenumНет

Формат выгрузки.

excelcsvjson

Ответы

Успешно

Отчёт сформирован и возвращён в теле ответа.

POST/v1/analytics/reports/products

curl --request POST \
  "$MARKETHOUSE_API_URL/v1/analytics/reports/products" \
  --header "Authorization: Bearer $MARKETHOUSE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "project_id": "4f02c943-7ec5-4f10-a38e-c8b44998bb25",
    "period_start": "2026-06-01",
    "period_end": "2026-06-30",
    "aggregation": "daily",
    "page": "dashboard",
    "pagination": 1,
    "sort_metric": "sum_discounted_price",
    "sort_direction": "DESC",
    "filters": { "product_merge_type": "none" }
  }'

200 OKПример ответа

{
  "pagination": {
    "total_pages": 12,
    "total_records": 238,
    "page_size": 20
  },
  "totals": [
    {
      "product": {
        "id": 78124,
        "name": "Футболка базовая",
        "seller_sku": "TSHIRT-001"
      },
      "sum_discounted_price": 348920.5,
      "count_product_orders": 612,
      "margin": 24.8,
      "roi": 31.4
    }
  ],
  "growth": [
    {
      "product_id": 78124,
      "sum_discounted_price": 14.2,
      "count_product_orders": 9.7
    }
  ],
  "empty": false,
  "project_metrics_meta": [],
  "errors": []
}