Спецификация получения рекомендаций по RSAPI

Для того, чтобы получить рекомендации необходимо сделать HTTP запрос (GET или POST) по следующему адресу https://rs.leadhit.io/get, передав необходимые параметры.

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

https://rs.leadhit.io/get?clid=123abc&lead_uid=456def&service_name=top_offers
Список возможных параметров:
Алгоритмы и используемые в них параметры:
Параметр \ Алгоритм cross_sale top_offers offer_upsale cart_upsale similar_offers buying_now search
clid v v v v v v v
lead_uid v v v v v v
service_name v v v v v v v
source v v v v v
offer_url v
url_list[] v v v v v
search_query v
lead_history_days_count v
category_id v
stock_id v v v v
limit v
extra_fields_filter v
Формат ответа:

Рекомендации отдаются в JSON формате, и представляют из себя список объектов следующего вида:

{
    "available": true, 
    "category_id": "20102", 
    "cities": [], 
    "description": "Air Jordan Legacy 312 – Гибридная модель, использующая элементы Air Jordan 1, Air Jordan 3 и Alpha Force Low.", 
    "extra_fields": {}, 
    "model": "Air Jordan", 
    "name": "Кроссовки Nike Air Jordan Legacy 312 Low", 
    "offer_id": "2145678", 
    "oldprice": "15000", 
    "picture": "https://media.leadhit.io/upload/_/noimage.png", 
    "picture_orig": "https://www.site.ru/product/123456/image.png", 
    "price": "12500", 
    "rating": 1.0, 
    "stock_fields": [], 
    "url": "https://www.site.ru/product/123456/", 
    "url_hash": "4c13e8d0f4b0", 
    "vendor": "Nike"
}

Аналитика по рекомендациям

Аналитика задействует статистику по виджетам рекомендаций. Для отдельного блока товарных рекомендаций, который вы используете на сайте, мы создаем виджет. Для формирования статистики, необходимо отправить запрос с событием с помощью JS функции Leadhit.sendWidgetStats, используя идентификатор виджета в качестве одного из параметров.

Вам необходимо согласовать с менеджером, какие алгоритмы сервиса рекомендаций мы хотите использовать и где разместить, чтобы мы запустили эти алгоритмы и создали к ним виджеты для сбора статистики. После этого менеджер сообщит вам идентификаторы виджетов, которые нужно использовать для отправки событий.

Как отправить событие

Показ (view) — это событие нужно отправить после загрузки блока с рекомендациями:

Leadhit.sendWidgetStats('123', 'view');

где 123 — идентификатор виджета, view — тип события.

Клик (click) — это событие нужно отправить после клика на товар из блока рекомендаций:

Leadhit.sendWidgetStats('123', 'click', {'offer_url': 'https://www.site.ru/product/123456/?lhsource=recommendations'});

где 123 — идентификатор виджета, click — тип события, https://www.site.ru/product/123456/ — URL товара, lhsource=recommendations — сервисный get-параметр для подсчета атрибуции заказов.

Атрибуция заказов

Для того, чтобы товарные рекомендации учитывались в атрибуции заказов, необходимо добавить в URL товаров параметр lhsource=recommendations, например https://www.site.ru/product/123456/?lhsource=recommendations.


Revision #19
Created 30 June 2020 16:40:59 by Leadhit
Updated 31 July 2024 21:01:56 by Leadhit