Аналитика

Для каждой компании доступны аналитические данные. Такие, как выручка, количество заказов, количество выкупленных заказов.

Данные доступны в разных разрезах, которые к тому же можно сочетать:

Маркетплейсы
Период
Детализация (час, день, неделя, месяц)

Метрики#

В разрезе компании доступны разного рода конкретизированные числовые данные - метрики.

На данный момент доступны следующиие метрики:

Выручка (revenues)
Количество продаж (sales)
Средний чек (averageChecks)
Количество заказов (orders)
Заказов доставлено (deliveredOrders)
Заказов возвращено (returnedOrders)
Процент возвратов (returnedOrdersInPercentage)
Количество заведенных продуктов (brands)
Количество брендов в продуктах (products)

Имена полей в ответе метода являются ID метрик.

Параметры запроса#

* - обязательные поля

Параметр	Описание
seller* int	Компания, по которому выполнить расчет
limit int	Ограничение элементов ответа. По умолчанию возвращается 100 последних
markets* string[]	Маркетплейсы, данные по которым включать расчет
periodFrom* string	Дата начала выборки, в формате `timestamp`
periodTo* string	Дата конца выборки, в формате `timestamp`
detailing* string	Детализация. Возможные значения: hour, day, week, month
productFilter* string	Наименование продукта, по которой фильтровать выборку. Поиск в названии происходит по шаблону "term" и без учета регистра. Например по запросу "Ябл" найдутся продукты: "Яблочный джем", "Лимонад яблочный"
categoryFilter* string	Наименование категории продуктов, по которой фильтровать выборку. Поиск в названии происходит по шаблону "term" и без учета регистра. Например по запросу "Шин" найдутся категории: "Шины", "машины"

Параметры ответа#

Параметр	Описание
success bool	Успешность запроса
errors string[string]	Ошибки запроса
data string[object]	Значения в формате `id метрики: данные метрики`
data[`id метрики`].unit string	Единица измерения
data[`id метрики`].data array	Список значений в разрезе времени
data[`id метрики`].data.value string	Значение метрики
data[`id метрики`].data.timestamp string	Момент времени на который высчитано значение

Запрос#

GET /api/v1/analytics/metrics HTTP/1.1
Host: lk.market
X-Client-Id: 1
X-Api-Token: f9327c5ec57vz66136923e101a4f2821m5c9983fa321123d86b3a7187t3a5c81
Content-Type: application/json

Успешный ответ 200:

{    "success": true,    "errors": [],    "data": {        "revenues": {            "unit": "ruble",            "data": [                {                    "timestamp": 1616198400,                    "value": 67                },                {                    "timestamp": 1616284800,                    "value": 70                }            ]        },        "sales": {            "unit": "pieces",            "data": [                {                    "timestamp": 1616198400,                    "value": 67                },                {                    "timestamp": 1616284800,                    "value": 70                }            ]        }    }}

Неудачный ответ 404:

{    "success": false,    "errors": {        "name": "not found"    },    "data": null}

Данные конкретной метрики#

Данные для каждой метрики можно получать отдельно. Для этого используйте ID метрики.

ID метрик являются имена полей в ответе метода метрики.