Відстеження активності на сайті за допомогою Generate event

Ви можете передавати та зберігати події, що отримуєте з вашого вебсайту, з вашого бекенду безпосередньо в нашу систему, використовуючи метод Generate event v2. Також, якщо ви налаштували інтеграцію із рекомендаційною системою, ви можете зберігати дані в обох сервісах.

Щоб зробити запит, надішліть вказані нижче параметри в тілі запиту на https://esputnik.com/api/v2/event:

Ви можете передавати наступні події:

pageViewed

Подія надсилається, коли контакт переглядає будь-яку сторінку або відкриває мобільне посилання на контент ("deeplink").

Приклад запиту наведений нижче. Він містить наступні параметри:

Приклад:

{
  "eventTypeKey": "pageViewed",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "380501234567"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "page",
      "value": "{"location":"https://example.com"}"
    }
  ]
}
JSON
COPY

productViewed

Подія відправляється, коли контакт переглядає певний продукт. Таку активність можна використовувати в алгоритмах рекомендацій.

Приклад запиту наведений нижче. Він містить наступні параметри:

Приклад:

{
  "eventTypeKey": "productViewed",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "411786452"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "product",
      "value": "{"productId":"WS01-L-Green","price":45.5,"isInStock":1,"someProductProperty":["green"]}]}"
    },
    {
      "name": "currencyCode",
      "value": "USD"
    }
  ]
}
JSON
COPY
MORE

productCategoryViewed

Подія відправляється коли контакт переглядає список товарів у зазначеній категорії.

Приклад запиту наведений нижче. Він містить наступні параметри:

Приклад: 

{
  "eventTypeKey": "productCategoryViewed",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "7411324763"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "category",
      "value": "{"productCategoryId":"Mugs"}"
    }
  ]
}
JSON
COPY

cartUpdated

Подія відправляється, коли контакт змінює товари у кошику. Повний перелік товарів у кошику передається з кожним запитом. Якщо кошик очищений, список товарів буде порожнім.

Приклад запиту наведено нижче. Він містить наступні параметри:

Приклад: 

{
  "eventTypeKey": "cartUpdated",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "73456712"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "products",
      "value": "[{"productId":"WS01-L-Green","quantity":1,"price":45.5}]"
    },
    {
      "name": "currencyCode",
      "value": "USD"
    },
    {
      "name": "recycleStateId",
      "value": "d59c6e6d-4123-4b0e-8c32-15f0656a8c60"
    }
  ]
}
JSON
COPY
MORE

productImpressions

Подія передає дані про товарний блок, який відображується на сайті. За замовчуванням він надсилається через JS API. Вам не потрібно надсилати його додатково.

Приклад запиту наведено нижче. Він містить наступні параметри:

Приклад: 

{
    "eventTypeKey": "productImpressions",
    "keyValue": "380501234567",
    "params": [
        // Locator or several locators to map an event to a contact
        {
            "name": "phone",
            "value": Phone
        },
        
        {            
            "name" : "recomVariantId"  // Required. Recom variant in r{recomId}v{variantId} format  
            "value" : string           // Mer: container_type
        },
        {
            "name": "products",  // Required. Mer: ProductImpression.Products
            "value": "[          // string contains JSON for a list                
                {
                    // Required product fields
                    "productId": string          // Mer: product_id
                },
                ...
            ]"
        }
    ]
}
JSON
COPY
MORE

productAddedToWishlist

Подія передає дані про товари, додані до списку бажань (категорія "Обране").

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

Приклад запиту наведено нижче. Він містить наступні параметри:

Приклад: 

{
    "eventTypeKey": "productAddedToWishlist",
    "keyValue": "380501234567",
    "params": [
        // Locator or several locators to map an event to a contact
        {
            "name": "phone",
            "value": Phone
        },
        
        {
            "name": "product",   // Required. Mer: AddToWishlist.Product
            "value": "{          // string contains JSON for a product
                            
                // Product fields
                "productId": string,       // Required. Mer: product_key
                "price": decimal,          // Required. Mer: price
                "isInStock": int,          // Optional. 0 or 1; Mer: isInStock                        

                // Extended product fields
                "someProductProperty": [ string, ... ],  // Mer: tag_someProductProperty
                ...
            }"
        }
        {
            "name": "currencyCode",       // Optional
            "value": CurrencyCode               
        }
    ]
}
JSON
COPY
MORE

searchRequest

Подія передає дані про пошукові запити, надіслані з пошукового рядка.

Ця подія використовується для тригерів. Надсилайте її, коли пошук не повертає результатів. У тригері такі контакти отримуватимуть персональні рекомендації (наразі надання рекомендацій не враховує значення, введене у рядку пошуку).

Приклад запиту наведено нижче. Він містить наступні параметри:

Приклад: 

{
    "eventTypeKey": "searchRequest",
    "keyValue": "380501234567",
    "params": [
        // Locator or several locators to map an event to a contact
        {
            "name": "phone",
            "value": Phone
        },
        
        {
            "name": "search",    // Required. Mer: SearchRequest.search
            "value": string
        },
        {
            "name": "isFound",    // 0 or 1. Optional, default 0. Mer: SearchRequest.isFound
            "value": int
        }
    ]
}
JSON
COPY