Перейти к основному содержимому

Цели

Цель — ключевое действие посетителя, которое вы хотите учитывать: отправка формы, подписка, переход в мессенджер, оформление заявки. Цели создаёт маркетолог в кабинете, а ваша система сообщает о их достижении.

Цели с сайта

На сайте цели удобнее отправлять функцией oct_goal() из JS-трекера — она вызывает этот метод через ваш приёмник.


Достижение цели по номеру

Номер цели маркетолог берёт в кабинете, в разделе целей.

POST /goals/12/hit
{
"sessid": "a1b2c3d4e5f60718",
"user_id": "1042",
"additional_data": {
"form": "callback",
"page": "/catalog/kurtki/"
}
}
ПолеОбязательноОписание
sessidдаИдентификатор сессии посетителя, тот же, что в визитах
user_idнетВаш идентификатор клиента, если посетитель опознан
additional_dataнетПроизвольный объект с подробностями события
Регистр имён полей не важен

sessid, SESSID и SessId — одно и то же поле. Имена внутри additional_data платформа не трогает.


Достижение цели по коду

Если удобнее не хранить у себя номера целей, используйте код цели — его тоже задаёт маркетолог в настройках цели. В адресе тогда указывается 0.

POST /goals/0/hit
{
"sessid": "a1b2c3d4e5f60718",
"goal_code": "callback_form",
"user_id": "1042"
}

Ответ и ошибки

{ "success": true, "code": 200 }

Ошибки приходят с HTTP 200, код — в поле code тела ответа, текст — в поле error.

codeПричина
400Не передан sessid, либо не указаны ни номер цели, ни goal_code, либо цель выключена
404Цель с таким номером или кодом не найдена

Требования и особенности:

  • цель должна быть создана и включена в кабинете — платформа не создаёт цели по факту обращения;
  • если посетитель ещё не опознан, user_id можно не передавать: достижение привяжется к сессии, а после связывания сессии с клиентом попадёт в его карточку;
  • цель можно засчитывать повторно — платформа хранит все достижения, а не только первое.

Цели, которые платформа присылает вам

Если маркетолог настроил цель на отслеживание элемента страницы, платформа присылает её описание через очередь команд — командами SYNC_GOAL и DELETE_GOAL. Обрабатывать их нужно только если вы сами показываете такие элементы и хотите засчитывать цели по клику.