Перші кроки
Відстеження подій та поведінки
Дані користувача
- Створення синхронізованих модулів
- Оформлення промовкладки для Gmail
- Налаштування Smart-елементів
- Огляд адаптивного email-редактора
- Налаштування адаптивності
- Додавання Rolloverʼа
- Додавання анкорних посилань
- Робота з блоком "Зображення"
- Додавання таблиці до листа
- Додавання фону до листа
- Додавання кастомних шрифтів
- Додавання кастомних іконок соцмереж
- Створення кнопки СТA
- Cтворення оформлення для листа
- Бібліотека блоків (Модулі)
Омніканальність
- Налаштування універсальних посилань (deeplinks & Universal links)
- Створення Google проекту для Mob Push
- Підключення мобільного додатка
- Планування мобільних push-повідомлень
- Налаштування аналітики доставлень та кліків
- Керування ключами доступу до мобільного SDK
- Створення мобільних push-повідомлень
- Звіти за мобільними push-розсилками
- SDK для мобільних застосунків
Автоматизація
Персоналізація
- HTTP-запит для передачі промокоду з повідомлення до картки контакту
- Принципи генерації промокодів за допомогою PHP/JAVA
- Підстановка промокоду з використанням API
- Завантаження промокодів для використання в сценарії
- Підстановка промокоду за допомогою персоналізації
- Підстановка промокоду з файлу
- Генерація промокодів у сценарії
- Відправлення промокоду за допомогою передпроцесора
Аналітика
API
- API-ключі
- Ресурси API для додавання контактів
- Використання API-ресурсу Send prepared message
- Отримання рекомендацій щодо API ресурсом Contact recommendations based on web tracking
- Передача замовлень API-ресурсом Generate event
- Використання API-ресурсу Generate event
- Інтеграція з API — найчастіші питання
Зміна системи
Документи
Інтеграція
Передавання даних про поведінку відвідувачів сайту через REST API
Якщо ви вже встановили скрипт веб-трекінгу на сайті, ви можете передавати до eSputnik події, щоб:
- точніше вибирати товари для покинутих кошиків і переглядів,
- пропонувати рекомендації на сторінках оформлення замовлення,
- управляти аудиторіями користувачів та ін.
Події можна відправляти до системи двома способами: через браузер, викликаючи функцію 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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
cookies |
"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Тип: Object String |
|
datetime |
1579622183208 |
|
ProductPage |
Обов'язковий Тип: Object |
Опис події |
productKey |
“72354” Тип: String |
|
price |
“754 USD” Тип: String |
|
isInStock |
“1” Тип: Int |
|
tag_[something] |
["abc","bca"] Тип: Array of Strings |
|
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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
datetime |
1579622183208 |
|
GUID |
“6F9619FF-8B86-D011-B42D-00CF4FC964FF” Тип: String |
|
StatusCart |
Обов'язковий Тип: Object String |
Опис об'єктів події Є масивом об'єктів, що містить товари, додані до кошика |
productKey |
“430738” Тип: String |
|
price |
“201.95” Тип: String |
|
discount |
“180” Тип: String |
|
quantity |
“1” Тип: Int |
|
price_currency_code |
"UAH" Тип: String |
|
tag_[something] |
["abc","bca"] Тип: Array of Strings |
|
Tags |
Необов'язковий Тип: Object |
Додаткові поля |
Wishlist
Опис
Надсилання події AddToWishlist - у момент додавання товару до списку бажаного (вибране).
Необхідна для розрахунку та виведення рекомендацій та надсилання тригерів пов'язаних зі списком бажань.
Параметри
Назва |
Приклад |
Опис |
GeneralInfo |
Обов'язковий Тип: Object String |
Загальна інформація |
eventName |
“AddToWishlist” Тип: String |
|
siteId |
“8A412DC” Тип: String |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
datetime |
1579622183208 |
|
GUID |
“6F9619FF-8B86-D011-B42D-00CF4FC964FF” Тип: String |
|
AddToWishlist |
Обов'язковий Тип: Object String |
Опис об'єктів події Є масивом об'єктів, що містить товари, додані до кошика |
productKey |
“430738” Тип: String |
|
price |
“201.95” Тип: String |
|
discount |
“180” Тип: String |
|
quantity |
“1” Type: Int |
|
price_currency_code |
"UAH" Тип: String |
|
tag_[something] |
["abc","bca"] Тип: Array of Strings |
|
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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
datetime |
1579622183208 |
|
cookies |
"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Тип: Object String |
|
GUID |
“6F9619FF-8B86-D011-B42D-00CF4FC964FF” Тип: String |
|
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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email
|
"user@mail.com" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
datetime |
1579622183208 |
|
cookies |
"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Тип: Object String |
|
OrderNumber |
“123/2017” Тип: String |
|
PurchasedItems |
Тип: Array of Strings |
|
product_id |
“430738” Тип: String |
|
unit_price |
“201.95” Тип: String |
|
quantity |
“1” Тип: Integer |
|
block_id |
“21246_r335v507” Тип: String |
|
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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
datetime |
1579622183208 |
|
cookies |
"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Тип: Оbject String |
|
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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
cookies |
"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Тип: Object String |
|
datetime |
1579622183208 |
|
CategoryPage |
Обов'язковий Тип: Object |
Опис події |
categoryKey |
“509876” Тип: String |
|
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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_es_contact_id |
"255830499" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
datetime |
1579622183208 |
|
cookies |
"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Тип: Object String |
|
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 |
|
externalCustomerId | "1234509876" Необов'язковий Тип: String |
|
user_phone |
"1-541-754-3010" Тип: String |
|
user_email |
"user@mail.com" Тип: String |
|
user_name |
"Gregori Boczynski" Тип: String |
|
datetime |
1579622183208 |
|
cookies |
"CDA68358-94FB-4D83-9655-3FEB3C4114A3" Тип: Object String |
|
CustomEvent |
Обов'язковий Тип: Array of Objects |
Опис кастомної події |
EventName |
"my_event" Тип: String |
|
Tags |
Необов'язковий Тип: Array of Objects |
|
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" |
Значення зі строки пошуку. Те, що шукаємо на сайті. |
isFound | 1/0 Необовʼязковий Тип: Int |
Якщо список пустий, повертається 0, якщо є дані - 1. |