Отслеживание активности на сайте при помощи 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