Описание API методов для аналитики виджетов рекомендаций

API методы для статистики виджетов рекомендаций

Типы событий:

generate — запрос на генерацию рекомендаций.
show — показ виджета с товарами.
click — клик по товару в виджете.
addToCart — добавление товара в корзину.
addToWishlist — добавление товара в избранное.

1. Событие generate — запрос на генерацию рекомендаций

Отправляется в момент, когда сайт запрашивает у SearchBooster список рекомендаций (например, при загрузке страницы).

Поля объекта события:

userId (string) — идентификатор пользователя (берется из cookie searchbooster_v2_user_id).
event (string) — фиксированное значение "generate".
widgetId (number) — идентификатор виджета.
pathname (string) — путь страницы, на которой происходит событие (например, /accessories/{id товара}).
regionId (string) — идентификатор региона.

Пример curl-запроса:

curl -X POST "https://api4.searchbooster.io/api/ca8fc618-9ee9-48f1-b9b6-92e810424297/widget-analytics" \
  -H "Content-Type: application/json" \
  -d '[{
    "userId": "VlKSsaRw9qe4qay84ZLMl_Bl6FsPsHX9SsMA2SF0as6|2.12.15.10",
    "event": "generate",
    "widgetId": 90,
    "pathname": "/",
    "regionId": null
  }]'

2. Событие show — показ виджета с товарами

Отправляется когда виджет рекомендаций отображается в видимой части экрана. Содержит список идентификаторов показанных товаров.

Поля объекта события:

itemIds (array of strings) — массив идентификаторов товаров, которые были показаны в виджете.

Пример curl-запроса:

curl -X POST "https://api4.searchbooster.io/api/ca8fc618-9ee9-48f1-b9b6-92e810424297/widget-analytics" \
  -H "Content-Type: application/json" \
  -d '[{
    "userId": "VlKSsaRw9qe4qay84ZLMl_Bl6FsPsHX9SsMA2SF0as6|2.12.15.10",
    "event": "show",
    "widgetId": 90,
    "pathname": "/",
    "regionId": null,
    "itemIds": ["1000", "10001", "10008", "10012",”5000”,”5001”,”5010”,”5012”]
  }]'

3. Событие click — клик по товару в виджете

Фиксируется при клике пользователя на карточку товара из виджета рекомендаций.

Поля объекта события:

itemIds (array of strings) — массив, содержащий один идентификатор товара, по которому кликнули.

Пример curl-запроса:

curl -X POST "https://api4.searchbooster.io/api/ca8fc618-9ee9-48f1-b9b6-92e810424297/widget-analytics" \
  -H "Content-Type: application/json" \
  -d '[{
    "userId": "VlKSsaRw9qe4qay84ZLMl_Bl6FsPsHX9SsMA2SF0as6|2.12.15.10",
    "event": "click",
    "widgetId": 90,
    "pathname": "/",
    "regionId": null,
    "itemIds": ["10001"]
  }]'

4. Событие addToCart — добавление товара в корзину

Отправляется, когда пользователь добавляет в корзину товар из виджета рекомендаций.

Поля объекта события:

itemIds (array of strings) — массив с одним идентификатором добавленного товара.

Пример curl-запроса:

curl -X POST "https://api4.searchbooster.io/api/ca8fc618-9ee9-48f1-b9b6-92e810424297/widget-analytics" \
  -H "Content-Type: application/json" \
  -d '[{
    "userId": "VlKSsaRw9qe4qay84ZLMl_Bl6FsPsHX9SsMA2SF0as6|2.12.15.10",
    "event": "addToCart",
    "widgetId": 90,
    "pathname": "/",
    "regionId": null,
    "itemIds": ["10001"]
  }]'

5. Событие addToWishlist — добавление товара в избранное

Отправляется, когда пользователь добавляет в избранное товар из виджета рекомендаций.

Поля объекта события:

itemIds (array of strings) — массив с одним идентификатором добавленного товара.

Пример curl-запроса:

curl -X POST "https://api4.searchbooster.io/api/ca8fc618-9ee9-48f1-b9b6-92e810424297/widget-analytics" \
  -H "Content-Type: application/json" \
  -d '[{
    "userId": "VlKSsaRw9qe4qay84ZLMl_Bl6FsPsHX9SsMA2SF0as6|2.12.15.10",
    "event": "addToWishlist",
    "widgetId": 90,
    "pathname": "/",
    "regionId": null,
    "itemIds": ["10001"]
  }]'