Перейти к содержимому

API статистики рекомендаций

Метрика Откуда
Генерации Событие generate — блок получил товары от API
Показы, клики События show и click в POST /widget-analytics
Корзины и покупки Ecommerce-события add_to_cart и purchase с widget_id или атрибуцией по клику (окно 1 час)
Выручка value событий purchase

Готовые <sb-widget> отправляют всё сами. Если вы рисуете рекомендации из API — отправляйте show и click:

Окно терминала
curl -X POST 'https://api.searchbooster.net/api/{uuid}/widget-analytics' \
-H 'Content-Type: application/json' \
-d '[{
"event": "show",
"widgetId": 402,
"userId": "docs-demo-user",
"itemIds": ["110244", "110348", "110166"],
"requestId": "0f6e8a1c-2b9d-4c55-9f1e-3a7c1e0d5b42",
"regionId": "msk",
"pathname": "/product/110166"
}]'
Поле Описание
event generate, show (блок в видимой области), click (клик по товару).
widgetId ID виджета — число.
itemIds Для show — все показанные товары, для click — один кликнутый.
requestId rid из ответа /widgets/{id}.
userId, regionId, pathname Посетитель, регион, страница (по ней определяется тип страницы в отчётах).

Можно отправлять массив из нескольких событий одним запросом. Ответ — {"status":200}.

Статистика доступна в кубе RecommendationWidgetStatsRaw через Cube API с тем же токеном статистики.

Метрики Разрезы
generated, shows, clicks, uniqueShows, uniqueClicks
ctr, ctrUnique
addToCart, purchases, revenue, avgCheck
crClickPurchase, crShowAddToCart, crAddToCartPurchase, rpm
eventDate, widgetId, widgetType, pageType, device, regionId, eventType

RecommendationWidgetStatsRawAttribution1h — те же метрики с атрибуцией покупки к клику по блоку в течение часа.

{
"measures": [
"RecommendationWidgetStatsRaw.shows",
"RecommendationWidgetStatsRaw.clicks",
"RecommendationWidgetStatsRaw.ctr",
"RecommendationWidgetStatsRaw.revenue"
],
"dimensions": ["RecommendationWidgetStatsRaw.widgetId", "RecommendationWidgetStatsRaw.pageType"],
"timeDimensions": [{ "dimension": "RecommendationWidgetStatsRaw.eventDate", "dateRange": "last 30 days" }],
"order": { "RecommendationWidgetStatsRaw.revenue": "desc" }
}