Первые шаги
Отслеживание событий и поведения
Пользовательские данные
- Создание сквозных модулей
- Оформление промовкладки для Gmail
- Настройка Smart-элементов
- Обзор адаптивного email-редактора
- Создание футера
- Настройка адаптивности
- Добавление Rolloverʼа
- Настройка блока "Меню"
- Добавление анкорных ссылок
- Робота с блоком "Изображения"
- Работа с блоком "Соцсети"
- Добавление таблицы в письмо
- Добавление фона в письмо
- Добавление пользовательских шрифтов
- Добавление кастомных иконок соцсетей
- Создание кнопки CTA
- Создание оформления для письма
- Редактирование HTML и CSS
- Работа с блоком "Баннер"
- Добавление блока "Видео"
- Библиотека блоков (Модули)
- Работа с блоком “Таймер"
Омниканальность
- Настройка универсальных ссылок (deeplinks & Universal links)
- Создание Google проекта для Mob Push
- Подключение мобильного приложения
- Планирование мобильных push-уведомлений
- Настройка аналитики доставляемости и кликов
- Управление ключами доступа к мобильному SDK
- Создание мобильных push-сообщений
- SDK для мобильных приложений
- Отчеты по мобильным push-рассылкам
Автоматизация
- Настройка формы подписки и двойного подтверждения
- Как настроить автоматическое поздравление с Днем рождения
- Согласование переменных события со сценарием на примере сценария "Заказ доставлен"
- Сегментация триггерных писем по дополнительным полям
- Запуск сценария после импорта контактов
- Контроль триггеров
- Как привязать сценарий к кнопке
- Устранение неполадок в работе сценариев
- Как настроить автоматическую реактивацию подписчиков и клиентов
- Настройка сценария для опросов и сбора отзывов
- Как отправить рассылку непрочитавшим
- Создание регулярного сценария для группы (видео)
- Создание welcome-цепочки для email-сообщений
Персонализация
- HTTP-запрос для передачи промокода из сообщения в карточку контакта
- Принципы генерации промокодов с помощью PHP/JAVA
- Подстановка промокода с использованием API
- Загрузка промокодов для использования в сценарии
- Подстановка промокода с помощью персонализации
- Подстановка промокода из файла
- Генерация промокодов в сценарии
- Отправка промокода с помощью препроцессора
Аналитика
- Настройка визуализации дохода от рассылок
- Отслеживание эффективности рассылок в Google Analytics
- Отчет по AMP-рассылке
- Отчет по Viber-рассылке
- Как корректно открыть CSV-файл после экспорта
- Отчёт по email-рассылке
- Настройка передачи UTM-меток
- Отчет по Web-push рассылке
- Отчет по SMS-рассылке
- Отчеты по мобильным push-рассылкам
Мультиязычность
API
- API-ключи
- Ресурсы API для добавления контактов
- Использование API-ресурса Send prepared message
- Получение рекомендаций по API ресурсом Contact recommendations based on web tracking
- Использование API-ресурса Generate event
- Интеграция с API – частые вопросы
- Передача заказов с помощью ресурса Generate event
Смена системы
Документы
Интеграция
Передача данных о поведении посетителей сайта через 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": {
"eventName": "AddToWishlist",
"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"
}
},
"AddToWishlist": {
"Product": {
"productKey": "72354",
"price": "754",
"isInStock": "1",
"tag_something": [
"abc",
"bca"
]
},
"Tags": {
"some_tags": [
"some_tag1",
"some_tag2"
]
}
}
}
Параметры
Название |
Пример |
Описание |
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” Тип: 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)
Описание
Событие используется в случае “покупки в 1 клик”, либо “покупки в кредит”. Событие отправляется опционально, в зависимости от способов покупки в интернет-магазине.
Пример
{
"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 |
Необязательный Type: 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" Type: О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. |