Регистрация события достижения цели
Описание
Регистрация события достижения цели. В рамках регистрации события также можно передавать дополнительную информацию о профиле.
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". |