Перші кроки

Події можна відправляти до системи двома способами: через браузер, викликаючи функцію eS.JS, або з бекенда, використовуючи REST API. У цій інструкції ми детально розглянемо другий варіант.

Важливо!

При налаштуванні трекінгу через REST API функціонал рекомендацій на сайті буде недоступний; у цьому випадку треба використовувати варіант виклику функцій eS.JS

Заголовки запиту

POST / HTTP/1.1

Host: https://tracker.esputnik.com/api/v2

Content-type: application/json

Код відповіді 204. Авторизація не потрібна.

ProductPage

Опис

Для якісного ранжування товарів/категорій або для відправлення тригерів за покинутими переглядами необхідно надіслати запит, у якому буде вказано:

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

Приклад

{

  "GeneralInfo": {
    "eventName": "ProductPage",
    "siteId": "8A412DC",
    "datetime":1579622183208,
    "externalCustomerId": "1234509876",
    "user_phone": "1-541-754-3010",
    "user_email": "user@mail.com",
    "user_name": "Gregori Boczynski",
    "user_es_contact_id": "255830499",
    "cookies": {
      "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
    }
  },

  "ProductPage": {
    "Product": {
      "productKey": "72354",
      "price": "754 USD",
      "isInStock": "1",
      "tag_something": [
        "abc",
        "bca"
      ]
    },
    "Tags": {
      "some_tags": [
        "some_tag1",
        "some_tag2"
      ]
    }
  }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов’язковий Тип: Object	Загальна інформація
eventName	“ProductPage” Обов’язковий Тип: String	Назва події, що відправляється
siteId	“8A412DC” Обов’язковий Тип: String	Ідентифікатор вашого магазину, можна отримати в підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Ім'я та прізвище користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
cookies	"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Обов'язковий Тип: Object String	Cookie sc - це cookie, згенерована нашим скриптом; її можна взяти з сайту Приклад виклику цієї cookie із javascript document.cookie, потрібна нам cookie має ім'я “sc”
datetime	1579622183208	Timestamp (millisecond)
ProductPage	Обов'язковий Тип: Object	Опис події
productKey	“72354” Обов'язковий Тип: String	Ідентифікатор товару Має збігатися з productKey на сторінці StatusCart та PurchasedItems
price	“754 USD” Необов'язковий Тип: String	Ціна за одиницю товару. Може передаватися із позначенням грошової валюти Якщо ціна на сайті змінилася, а у фіді ще ні, то до бази запишеться значення з сайту
isInStock	“1” Необов'язковий Тип: Int	Відповідає за наявність товару Параметр може набувати двох значень: “0” - товару немає в наявності “1” - товар є в наявності Якщо наявність товару на сайті змінилася, а у фіді ще ні, то до бази запишеться значення з сайту
tag_[something]	["abc","bca"] Необов'язковий Тип: Array of Strings	Усі додаткові поля можуть передаватися в цьому параметрі, обов'язковим є префікс tag_, після якого можна написати будь-яку назву Таких параметрів може бути кілька Значення цього параметра передається у вигляді масиву даних, який можна записувати через кому
Tags	Необов'язковий Тип: Object	Додаткові поля

StatusCart

Опис

Подія, що відправляється в момент зміни кошика (з новим GUID), наприклад на картці товару або сторінці категорій за кнопкою “Купити”. Кошик має оновлюватися з усіх сторінок. Якщо кошик порожній, то необхідно відправити порожній кошик (порожній масив без товарів).

Приклад

{

  "GeneralInfo": {
    "eventName": "StatusCart",
    "siteId": "8A412DC",
    "datetime":1579622183208,
    "externalCustomerId": "1234509876",
    "user_phone": "1-541-754-3010",
    "user_email": "user@mail.com",
    "user_name": "Gregori Boczynski",
    "user_es_contact_id": "255830499",
    "cookies": {
      "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
    }
  },
  "StatusCart": {
    "GUID": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
    "Products": [
      {
        "productKey": "430738",
        "price": 201.95,
        "discount": 180,
        "quantity": 1,
        "price_currency_code": "UAH",
        "tag_something": [
          "aaa",
          "bbb"
        ]
      },
      {
        "productKey": "902339",
        "price": 596,
        "discount": 590,
        "quantity": 1,
        "price_currency_code": "UAH",
        "tag_something": [
          "aaa",
          "bbb"
        ]
      }
    ],
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Object String	Загальна інформація
eventName	“StatusCart” Обов'язковий Тип: String	Назва події, що відправляється
siteId	“8A412DC” Обов'язковий Тип: String	Ідентифікатор вашого магазину можна отримати в підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Ім'я/Прізвище користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
datetime	1579622183208	Timestamp (millisecond)
GUID	“6F9619FF-8B86-D011-B42D-00CF4FC964FF” Обов'язковий Тип: String	Унікальний ідентифікатор, що пов'язує дві події StatusCart і PurchasedItems Має бути ідентичним GUID у події PurchasedItems Може бути згенерований із випадкових цифр та латинських літер
StatusCart	Обов'язковий Тип: Object String	Опис об'єктів події Є масивом об'єктів, що містить товари, додані до кошика
productKey	“430738” Обов'язковий Тип: String	Ідентифікатор товару Має збігатися з productKey на сторінці ProductPage
price	“201.95” Обов'язковий Тип: String	Ціна за одиницю товару
discount	“180” Необов'язковий Тип: String	Знижкова ціна за одиницю товару
quantity	“1” Обов'язковий Тип: Int	Кількість товарів
price_currency_code	"UAH" Необов'язковий Тип: String	Позначення грошової валюти
tag_[something]	["abc","bca"] Необов'язковий Тип: Array of Strings	Усі додаткові поля можуть передаватися в цьому параметрі, обов'язковий префікс tag_, після якого можна написати будь-яку назву Таких параметрів може бути кілька Значення цього параметра передається у вигляді масиву даних, який можна записувати через кому
Tags	Необов'язковий Тип: Object	Додаткові поля

Wishlist

Опис

Надсилання події AddToWishlist - у момент додавання товару до списку бажаного (вибране).

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

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Object String	Загальна інформація
eventName	“AddToWishlist” Обов'язковий Тип: String	Назва події, що відправляється
siteId	“8A412DC” Обов'язковий Тип: String	Ідентифікатор вашого магазину можна отримати в підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Ім'я/Прізвище користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
datetime	1579622183208	Timestamp (millisecond)
GUID	“6F9619FF-8B86-D011-B42D-00CF4FC964FF” Обов'язковий Тип: String	Унікальний ідентифікатор, що пов'язує дві події StatusCart і PurchasedItems Має бути ідентичним GUID у події PurchasedItems Може бути згенерований із випадкових цифр та латинських літер
AddToWishlist	Обов'язковий Тип: Object String	Опис об'єктів події Є масивом об'єктів, що містить товари, додані до кошика
productKey	“430738” Обов'язковий Тип: String	Ідентифікатор товару Має збігатися з productKey на сторінці ProductPage
price	“201.95” Обов'язковий Тип: String	Ціна за одиницю товару
discount	“180” Необов'язковий Тип: String	Знижкова ціна за одиницю товару
quantity	“1” Обов'язковий Type: Int	Кількість товарів
price_currency_code	"UAH" Необов'язковий Тип: String	Позначення грошової валюти
tag_[something]	["abc","bca"] Необов'язковий Тип: Array of Strings	Усі додаткові поля можуть передаватися в цьому параметрі, обов'язковий префікс tag_, після якого можна написати будь-яку назву Таких параметрів може бути кілька Значення цього параметра передається у вигляді масиву даних, який можна записувати через кому
Tags	Необов'язковий Тип: Object	Додаткові поля

PurchasedItems

Опис

Для виведення рекомендацій на сторінці підтвердження замовлення або для відправлення тригерів за покинутими кошиками необхідно надіслати запит, у якому буде вказано, який товар придбав користувач.

Приклад

{
  "GeneralInfo": {
    "eventName": "PurchasedItems",
    "siteId": "8A412DC",
    "datetime":1579622183208,
    "externalCustomerId": "1234509876",
    "user_phone": "1-541-754-3010",
    "user_email": "user@mail.com",
    "user_name": "Gregori Boczynski",
    "user_es_contact_id": "255830499",
    "cookies": {
      "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
    }
  },
  "PurchasedItems": {
    "GUID": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
    "OrderNumber": "123/2017",
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Object String	Загальна інформація
eventName	“StatusCart” Обов'язковий Тип: String	Назва події, що відправляється
siteId	“8A412DC” Обов'язковий Тип: String	Ідентифікатор вашого магазину, можна отримати у підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
datetime	1579622183208	Timestamp (millisecond)
cookies	"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Обов'язковий Тип: Object String	Cookie sc - це cookie, згенерована нашим скриптом; її можна взяти з сайту Приклад виклику цієї cookie із javascript document.cookie, потрібна нам cookie має ім'я “sc”
GUID	“6F9619FF-8B86-D011-B42D-00CF4FC964FF” Обов'язковий Тип: String	Унікальний ідентифікатор, що пов'язує дві події StatusCart і PurchasedItems Має бути ідентичним GUID у події StatusCart Може бути згенерований із випадкових цифр та латинських літер
OrderNumber	“123/2017” Обов'язковий Тип: String	Номер замовлення Є підтвердженням здійснення купівлі
Tags	Необов'язковий Тип: Object	Додаткові поля

PurchasedItems (one click)

Опис

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

Приклад

{
  "GeneralInfo": {
    "eventName": "PurchasedItems",
    "siteId": "8A412DC",
    "datetime":1579622183208,
    "externalCustomerId": "1234509876",
    "user_phone": "1-541-754-3010",
    "user_email": "user@mail.com",
    "user_name": "Gregori Boczynski",
    "user_es_contact_id": "255830499",
    "cookies": {
      "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
    }
  },
  "PurchasedItems": {
    "Products": [
      {
        "product_id": "430738",
        "unit_price": "201.95",
        "quantity": 1
      },
      {
        "product_id": "211452",
        "unit_price": "341.80",
        "quantity": 2
      }
    ],
    "OrderNumber": "123/2017",
    "Tags": {
      "block_id": [
        "21246_r335v507"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Object String	Загальна інформація
eventName	“StatusCart” Обов'язковий Тип: String	Назва події, що відправляється
siteId	“8A412DC” Обов'язковий Тип: String	Ідентифікатор вашого магазину, можна отримати у підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Ім'я/Прізвище користувача
datetime	1579622183208	Timestamp (millisecond)
cookies	"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Обов'язковий Тип: Object String	Cookie sc - це cookie, згенерована нашим скриптом; її можна взяти з сайту Приклад виклику цієї cookie із javascript document.cookie, потрібна нам cookie має ім'я “sc”
OrderNumber	“123/2017” Обов'язковий Тип: String	Номер замовлення Є підтвердженням здійснення купівлі
PurchasedItems	Тип: Array of Strings	Перелік товарів
product_id	“430738” Обов'язковий Тип: String	Ідентифікатор товару Має збігатися з productKey на сторінці ProductPage
unit_price	“201.95” Обов'язковий Тип: String	Ціна за одиницю товару
quantity	“1” Обов'язковий Тип: Integer	Кількість товарів
block_id	“21246_r335v507” Обов'язковий Тип: String	Ідентифікатор блоку рекомендацій. Можна отримати від підтримки eSputnik.
Tags	Необов'язковий Тип: Object	Додаткові поля

ProductImpressions

Опис

ProductImpressions — подія, відправлення якої дозволяє відстежувати покази блоків. За замовчуванням відправляється скриптом, по JS API. Додатково передавати не потрібно.

Приклад

{
  "GeneralInfo": {
    "eventName": "ProductImpressions",
    "siteId": "8A412DC",
    "datetime":1579622183208,
    "externalCustomerId": "1234509876",
    "user_phone": "1-541-754-3010",
    "user_email": "user@mail.com",
    "user_name": "Gregori Boczynski",
    "user_es_contact_id": "255830499",
    "cookies": {
      "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
    }
  },
  "ProductImpression": {
    "Products": [
      {
        "product_id": "430968",
        "container_type": "1253"
      },
      {
        "product_id": "430738",
        "container_type": "1254"
      },
      {
        "product_id": "429983",
        "container_type": "1255"
      }
    ],
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Array of Objects	Загальна інформація
eventName	“ProductImpressions” Обов'язковий Тип: String	Назва події, що відправляється
siteId	“8A412DC” Обов'язковий Тип: String	Ідентифікатор вашого магазину, можна отримати в підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Імя/Прізвище користувача
datetime	1579622183208	Timestamp (millisecond)
cookies	"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Обов'язковий Тип: Оbject String	Cookie sc - це cookie, згенерована нашим скриптом; її можна взяти з сайту Приклад виклику цієї cookie із javascript document.cookie, потрібна нам cookie має ім'я “sc”
ProductImpression	Обов'язковий Тип: Array of Objects	Опис об'єктів події Є масивом об'єктів
product_id	“430968” Обов'язковий Тип: String	Ідентифікатор товару чи категорії, який є у фіді
container_type	“1253” Обов'язковий Тип: String	Номер блоку рекомендацій.
Tags	Необов'язковий Тип: Object	Додаткові поля

CategoryPage

Опис

Можливе використання:

для тригерів,
перегляду сайту з відвідуванням категорії, без відвідування картки товарів,
перегляду сайту без будь-якого відвідування категорії/товару.

Необхідно надіслати запит, у якому буде вказано, на якій категорії знаходиться користувач.

Приклад

{
  "GeneralInfo": {
    "eventName": "CategoryPage",
    "siteId": "8A412DC",
    "datetime":1579622183208,
    "externalCustomerId": "1234509876",
    "user_phone": "1-541-754-3010",
    "user_email": "user@mail.com",
    "user_name": "Gregori Boczynski",
    "user_es_contact_id": "255830499",
    "cookies": {
      "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
    }
  },
  "CategoryPage": {
    "Category": {
      "categoryKey": "509876"
    },
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Object	Загальна інформація
eventName	“ProductPage” Обов'язковий Тип: String	Назва події, що відправляється
siteId	“8A412DC” Обов'язковий Тип: String	Ідентифікатор вашого магазину можна отримати в підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Ім’я та Прізвище користувача
cookies	"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Обов'язковий Тип: Object String	Cookie sc - це cookie, згенерована нашим скриптом; її можна взяти з сайту Приклад виклику цієї cookie із javascript document.cookie, потрібна нам cookie має ім'я “sc”
datetime	1579622183208	Timestamp (millisecond)
CategoryPage	Обов'язковий Тип: Object	Опис події
categoryKey	“509876” Обов'язковий Тип: String	Назва або ID категорії
Tags	Необов'язковий Тип: Object	Додаткові поля

CustomerData

Опис

Для відправлення тригерів за покинутими кошиками та покинутими переглядами необхідно надіслати запит, у якому буде вказана інформація про користувача.

Email має відправлятися як мінімум у персональному кабінеті, на сторінці "Дякуємо за замовлення" та під час реєстрації.

Приклад

{
 "GeneralInfo": {
   "eventName": "CustomerData",
   "siteId": "8D3869C",
   "datetime":1579622183208,
   "externalCustomerId": "1234509876",
   "user_phone": "3801111111111",
   "user_email": "user@mail.com",
   "user_es_contact_id": "255830499",
   "user_name": "Johny",
   "cookies": {
     "sc": "CDA68358-94FB-4D83-9655-3FEB3CGGG1"
   }
 }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Array of Objects	Загальна інформація
eventName	“StatusCart” Обов'язковий Тип: String	Назва події, що відправляється
siteId	“8D3869C” Обов'язковий Тип: String	Ідентифікатор вашого магазину можна отримати в підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_es_contact_id	"255830499" Необов'язковий Тип: String	ID клієнта в базі eSputnik
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Ім’я/Прізвище користувача
datetime	1579622183208	Timestamp (millisecond)
cookies	"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Обов'язковий Тип: Object String	Cookie sc - це cookie, згенерована нашим скриптом; її можна взяти з сайту Приклад виклику цієї cookie із javascript document.cookie, потрібна нам cookie має ім'я “sc”

CustomEvent

Опис

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

Приклад

{
    "GeneralInfo": {
        "eventName": "CustomEvent",
        "datetime":1579622183208,
        "externalCustomerId": "1234509876",
        "screendim": {
            "h": 1200,
            "w": 2304
        },
        "adblockEnabled": true,
        "device": "Desktop",
        "browser": {
            "name": "Chrome",
            "chrome": true,
            "version": "74.0",
            "webkit": true,
            "a": true
        },
        "siteId": "8A412DC",
        "cookies": {
            "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
        },
        "s_location": "https://example.com/product_id.html",
        "referrer": "https://example.com",
        "user_client_id": "",
        "user_city": "",
        "user_card_id": "",
        "user_name": "Gregori Boczynski",
        "user_phone": "1-541-754-3010",
        "user_email": "user@mail.com",
        "user_es_contact_id": "255830499"
    },
    "CustomEvent": {
     "EventName":"my_event",
     "Tags": {
     "some_tags": [
         "1",
         "a2"
     ],
     "some_tags1": [
       "4",
     "gg"
     ]
}
    }
}

Параметри

Назва	Приклад	Опис
GeneralInfo	Обов'язковий Тип: Array of Objects	Общая информация Загальна інформація
eventName	“CustomEvent” Обов'язковий Тип: String	Название отправляемого события Назва події, що відправляється
siteId	“8A412DC” Обов'язковий Тип: String	Идентификатор вашего магазина, можно получить в поддержке eSputnik Статический параметр Ідентифікатор вашого магазину можна отримати в підтримці eSputnik Статичний параметр
externalCustomerId	"1234509876" Необов'язковий Тип: String	Зовнішній ідентифікатор контакту
user_phone	"1-541-754-3010" Необов'язковий Тип: String	Номер телефону в міжнародному форматі
user_email	"user@mail.com" Необов'язковий Тип: String	Email користувача
user_name	"Gregori Boczynski" Необов'язковий Тип: String	Ім’я/Прізвище користувача
datetime	1579622183208	Timestamp (millisecond)
cookies	"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Обов'язковий Тип: Object String	Cookie sc - является cookie сгенерированной нашим скриптом, которую можно взять с сайта Пример вызова данной cookie из javascript document.cookie, нужная нам cookie имеет имя “sc” Cookie sc - це cookie, згенерована нашим скриптом; її можна взяти з сайту Приклад виклику цієї cookie із javascript document.cookie, потрібна нам cookie має ім'я “sc”
CustomEvent	Обов'язковий Тип: Array of Objects	Опис кастомної події
EventName	"my_event" Обов'язковий Тип: String	Назва кастомної події
Tags	Необов'язковий Тип: Array of Objects	Пользовательские поля, где "some_tags" - название поля, а "1", "a2" - его значение(я) (всегда имеют тип список строк) Кастомні поля, де "some_tags" - назва поля, а "1", "a2" - його значення(я) (завжди мають тип “список рядків”)

ProductUpdate

Опис

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

Приклад

{
  "GeneralInfo": {
    "eventName": "ProductUpdate",
    "siteId": "site_id"
  },
  "ProductUpdate": [
    {
      "brand": "Apple",
      "name": "iPhone 7",
      "description": "Some description",
      "product_id": "430738",
      "imgurl": "https://domain.com/apple/product_large.png",
      "unit_price": "201.95",
      "isInStock": "1",
      "tag_discount": ["10"],
      "tag_oldprice": ["224.38"],
      "price_currency_code": "UAH",
      "category": "level3",
      "category_id": ["3"],
      "tag_something": [
        "aaa",
        "bbb"
      ]
    },
    {
      "brand": "Apple",
      "name": "iPhone 7",
      "description": "Some description",
      "product_id": "430738",
      "imgurl": "https://domain.com/apple/product_large.png",
      "unit_price": "201.95",
      "isInStock": "1",
      "tag_discount": ["10"],
      "tag_oldprice": ["224.38"],
      "price_currency_code": "UAH",
      "category": "level1 > level2 > level3",
      "category_id": ["1", "2", "3"],
      "tag_something": [
        "aaa",
        "bbb"
      ]
    }
  ]
}

Параметри

Назва	Приклад	Опис
ProductUpdate	required	required
siteId	site_id	required
product_id	430738	required
isInStock	1	required, could be 0 or 1
unit_price	201.95	optional field
description	Some description	optional field
name	iPhone 7	optional field
imgurl	https://domain.com/apple/product_large.png	optional field
brand	Apple	optional field
tag_discount	10	optional field
price_currency_code	UAH	optional field
tag_oldprice	224.38	optional field

Якщо на товар діє знижка, інформація про нього має передаватися в такий спосіб:

{
 "product_id": "1111",
 "unit_price": 270,
 "isInStock": 1,
 "price_currency_code": "UAH",
 "tag_oldprice": [
   "300"
 ],
 "tag_discount": [
   "10"
 ]
}

SearchRequest

Опис

Для збору статистики за пошуковими запитами необхідно надіслати значення зі строки пошуку.

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

Приклад

{
    "GeneralInfo": {
        "eventName": "SearchRequest",
        "siteId": "CE460EC",
        "datetime": 1668792552000,
        "externalCustomerId": "1234509876",
        "user_phone": "1-541-754-3010",
        "user_email": "userdech123@mail.com",
        "user_name": "Gregori Boczynski",
        "user_es_contact_id": "",
        "cookies": {
            "sc": "CDA68358-94FB-4D83-9655-3FEB3C4114A3"
        }
    },
    "SearchRequest": {
        "search": "input_value",
        "isFound": 1
    }
}

Параметри

Назва	Приклад	Опис
search	"Coffe" Обов’язковий Тип: String	Значення зі строки пошуку. Те, що шукаємо на сайті.
isFound	1/0 Необовʼязковий Тип: Int	Якщо список пустий, повертається 0, якщо є дані - 1.

Перші кроки

Курси

Відстеження подій та поведінки

Дані користувача

Email

Омніканальність

Автоматизація

Персоналізація

Аналітика

Мультимовність

API

Зміна системи

Документи

Інтеграція

​​​​​​​Передавання даних про поведінку відвідувачів сайту через REST API

ProductPage

Опис

Приклад

Параметри

StatusCart

Опис

Приклад

Параметри

Wishlist

Опис

Параметри

PurchasedItems

Опис

Приклад

Параметри

PurchasedItems (one click)

Опис

Приклад

Параметри

ProductImpressions

Опис

Приклад

Параметри

CategoryPage

Опис

Приклад

Параметри

CustomerData

Опис

Приклад

Параметри

CustomEvent

Опис

Приклад

Параметри

ProductUpdate

Опис

Приклад

Параметри

SearchRequest

Опис

Приклад

Параметри

Передавання даних про поведінку відвідувачів сайту через REST API