Отчёт P&L

Возвращает помесячный и годовой отчёт о прибылях и убытках с динамикой показателей.

POST/v1/analytics/reports/pnlAPI Preview

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

Метод формирует P&L по полным месяцам и годам, рассчитывает пользовательские метрики и изменение каждого показателя относительно предыдущего периода.

Если выбранный диапазон охватывает меньше трёх месяцев, отчёт расширяется назад до трёх полных месяцев.
Месячные и годовые строки возвращаются одновременно в одном ответе.
Фильтры кабинетов применяются к базовым данным до расчёта итоговых показателей.

Авторизация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

sort_metricstringДа

Служебная метрика сортировки.

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

sort_directionenumДа

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

ASCDESC

exportbooleanНет

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

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

formatenumНет

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

excelcsvjson

Ответы

Успешно

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

POST/v1/analytics/reports/pnl

curl --request POST \
  "$MARKETHOUSE_API_URL/v1/analytics/reports/pnl" \
  --header "Authorization: Bearer $MARKETHOUSE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "project_id": "4f02c943-7ec5-4f10-a38e-c8b44998bb25",
    "period_start": "2026-04-01",
    "period_end": "2026-06-30",
    "aggregation": "monthly",
    "page": "dashboard",
    "pagination": 1,
    "sort_metric": "period",
    "sort_direction": "ASC",
    "filters": { "connections": null }
  }'

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

{
  "months": [
    {
      "period": "2026-04",
      "sum_discounted_price": 2310400.2,
      "sum_profit": 486920.5,
      "margin": 21.08
    },
    {
      "period": "2026-05",
      "sum_discounted_price": 2498620.8,
      "sum_profit": 548315.75,
      "margin": 21.94
    },
    {
      "period": "2026-06",
      "sum_discounted_price": 2671105.4,
      "sum_profit": 602540.1,
      "margin": 22.56
    }
  ],
  "months_growth": [
    { "period": "2026-04", "sum_profit": 0 },
    { "period": "2026-05", "sum_profit": 12.61 },
    { "period": "2026-06", "sum_profit": 9.89 }
  ],
  "years": [
    {
      "period": "2026",
      "sum_discounted_price": 7470126.4,
      "sum_profit": 1637776.35
    }
  ],
  "years_growth": [{ "period": "2026", "sum_profit": 0 }],
  "empty": false,
  "errors": []
}