Регистрация события достижения цели
Описание
Запрос регистрирует событие достижения цели. В рамках регистрации события также можно передавать дополнительную информацию о профиле.
Данные о событии достижения цели можно использовать в следующих механиках платформы:
- сегментация профилей по истории действий;
- запуск триггерной кампании или сценария;
- движение профиля по сценарию (ноды "Условие", "JSON-фильтр" и "Вызов API");
- подставновка динамического контента в шаблоны сообщений.
URL-адрес
Метод: POST
https://example.com/api/v1.1/goals/register
Параметры запроса
Основные параметры
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
db_id | int | 1 | Да | Идентификатор базы данных |
pixel_id | int | 1 | Да | Идентификатор пикселя |
goal | string | "card" | Нет | Название цели |
goals | JSON array |
| Нет | Несколько целей со значениями |
value | float | -25.5 | Нет | Значение цели |
date | string | "2006-01-25T15:04:05+07:00" | Нет | Дата события в формате RFC 3339 |
Параметры матчинга
Эти параметры используются для поиска профиля в базе. Подробнее.
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
matching | string | "email" – поиск по email из профиля или подписок "email_profile" – по email из профиля "email_sub" – по email из подписок "phone" – по телефону из профиля или подписок "phone_sub" – по телефону из подписок "profile_id" – по идентификатору профиля (только при обновлении!) "push_sub" – по пуш подписке "custom" – по кастомному полю "custom_sub" – по подписке на кастомный канал "email_phone" – по email или телефону из профиля "email_phone_sub" – по email или телефону из подписок | Нет, если поиск по email из профиля или подписок | Режим поиска подписчика. По умолчанию - email. |
string | "john@example.com" | "matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю | Email-адрес | |
phone | string | "+79000000000" | "matching":"phone" | Номер телефона |
profile_id | string | "abcdefghijklmnqrstuvwxyz" | "matching":"profile_id" | Идентификатор профиля |
field_name | string | "CRM_ID" | "matching":"custom" | Название кастомного поля профиля для поиска. |
field_value | int/string | "12345" | "matching":"custom" | Значение кастомного поля для поиска. Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2". |
Дополнительные параметры
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
pixel_data | JSON object |
| Нет | JSON-объект с дополнительными данными события цели. Объект не должен содержать вложенные объекты или массивы. Размер объекта не больше 1 KB. |
skip_triggers | bool | false | Нет | Отключает настроенные на событие триггеры и сценарии. По умолчанию — false. |
enrich_profile | bool | true | Нет | Событие обновляет данные профиля. Используется для обновления данных через следующие поля: browser, os, device, country, region, city, zip, time_zone. |
is_test | bool | false | Нет | Событие отмечается как тестовое для аналити ки. По умолчанию — false. |
vendor | string | "altcraft" | Нет | Поле профиля _vendor на момент события |
external_type | string | "event_pixel_test" | Нет | Тип внешнего идентификатора |
external_event_id | string | "qwerty123" | Нет | Внешний идентификатор |
altcraft_client_id | string | "9f11d32d-2935-43d0-b8df-f4c3568095b2" | Нет | Уникальный сквозной идентификатор Altcraft |
HTTP-параметры
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
referer | string | "api.example.com" | Нет | Заголовок запроса Referer |
user_agent | string | "Mozilla/5.0 (Linux; Android 6.0.1; SM-G935S Build/MMB29K; wv)" | Нет | Заголовок запроса User-Agent |
accept_language | string | "fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5" | Нет | Язык операционной системы устройства клиента (Заголовок запроса Accept-Language) |
client_ip | string | "10.0.0.0" | Нет | IP клиента из оригинального запроса |
client_ip_v4 | string | "198.16.74.224" | Нет | IPv4 адрес клиента |
client_ip_v6 | string | "fe80::5215:5556:d75f:806b" | Нет | IPv6 адрес клиента |
browser | string | "Chrome" | Нет | Браузер клиента Получить список допустимых значений можно через запрос /v1.1/dictionary ("browsers") |
os | string | "Ubuntu" | Нет | Операционная система клиента Получить список допустимых значений можно через запрос /v1.1/dictionary ("oses") |
device | string | "Desktop" | Нет | Тип клиентского устройства Получить список допустимых значений можно через запрос /v1.1/dictionary ("devices") |
Поля browser, os и device автоматически заполняются платформой на основе содержимого поля user_agent.
Если в одном запросе вы передаёте и user_agent, и отдельные значения для browser, os и device, то данные из user_agent имеют приоритет и перезаписывают указанные значения.
Если вы передаёте поля browser, os и device без user_agent, для обновления профиля необходимо указать "enrich_profile": true
, иначе платформа не обновит профиль.
Параметры геолокации
Платформа автоматически определит значения, если передать client_ip
.
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
lat | float | 55.244075 | Да, если передаётся lon | Широта клиента |
lon | float | 55.244075 | Да, если передаётся lat | Долгота клиента |
country | string | "RU" | Нет | Страна клиента (ISO-код или полное название) |
region | string | "Ryazan" | Нет | Регион клиента |
city | string | "Ryazan" | Нет | Город клиента |
address | string | "Pochtovaya street" | Нет | Адрес клиента |
zip | string | "390000" | Нет | Почтовый индекс клиента |
time_zone | string | "Europe/Moscow" | Нет | Часовой пояс |
Платформа автоматически определяет значения полей country, region, city, zip и time_zone на основе IP-адреса, переданного в параметрах client_ip, client_ip_v4 или client_ip_v6. Если в запросе указаны как IP-адрес, так и отдельные значения для этих полей, данные, определённые по IP, будут иметь приоритет и перезапишут переданные вручную значения.
Для обновления профиля с использованием значений из полей country, region, city, zip и time_zone необходимо установить параметр "enrich_profile": true
.
UTM-параметры
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
utm_content | string | "utm_content" | Нет | UTM параметры |
utm_medium | string | "utm_medium" | Нет | |
utm_source | string | "utm_source" | Нет | |
utm_campaign | string | "utm_campaign" | Нет | |
utm_term | string | "utm_term" | Нет |
Параметры сети
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
net_ssid | string | "10.200.0.0" | Нет | Имя сети клиента |
net_mac_addr | string | "28:87:ba:c1:0d:5e" | Нет | MAC-адрес клиента |
net_gateway_ipv4 | string | "10.200.0.1" | Нет | IPv4 адрес шлюза клиента |
net_gateway_ipv6 | string | "::ff" | Нет | IPv6 адрес шлюза клиента |
Параметры кампании
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
send_message_id | string | "abcdefghijklmnqrstuvwxyz" | Нет | Идентификатор отправленного сообщения в платформе. Позволяет связать событие пикселя с конкретной кампанией. |
Параметры программы лояльности
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
loyalty_id | int | 5 | Нет | Идентификатор программы лояльности |
promo_id | string | "6285183c3f62fcd4ac5ed36d" | Нет | Идентификатор привязанного промокода |
Параметры маркета
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
endpoint_eid | string | "example_endpoint" | Нет | Внешний идентификатор точки контакта. Если для пикселя выбрана определенная база профилей, то эта база должна совпадать с базой канала продаж. |
order_eid | string | "12345" | Нет | Внешний идентификатор заказа |
product_eid | string | "example_product" | Да, если передается sku_eid | Внешний идентификатор продукта |
sku_eid | string | "example_sku" | Нет | Внешний идентификатор SKU. При использовании этого параметра в запросе также необходимо передавать product_eid. |
region_eid | string | "region_eYFe2AE6s" | Нет | Внешний идентификатор региона |
count_items | int | 1 | Нет | Количество товара в позиции заказа |
categories | array |
| Нет | Категории продукта или SKU |
Максимальная длина любого строкового поля — 128 символов.