Свойства пользователя

Здесь собрана различная информация о свойствах пользователя.

Не стоит путать свойства пользователя и свойства события. Свойства события отражают дополнительную информацию о событии (например, у события "Сделал заказ" могут быть свойства "Сумма", "Товары" и т.д.). Свойства пользователя отражают информацию о пользователе. Например, имя, email, количество заказов, сумма всех заказов и т.д.

Типы данных

Поддерживается пять типов данных:

число
строка
дата/время
логический (булев)
список

Числа могут быть только целыми в диапазоне -2^53 .. +2^53, или -9007199254740992 .. +9007199254740992.

Максимальная длина строки 255 символов.

Элементами списка могут быть только строки длиной до 255 символов (максимум 30 элементов в списке).

Дата/время в формате ISO 8601: YYYY-MM-DDTHH:MM:SS. Допускается сокращенный вариант: YYYY-MM-DD (в этом случае будет подставлено время 00:00:00).

Пример:

{
    value1: 145,
    value2: "Hello, world!",
    value3: true,
    value4: "2015-09-13T13:25:05",
    value5: ["element1", "element2", "element3"]
}

Формат установки свойств

Иногда простой установки свойств недостаточно. Например, если вы отслеживаете количество нажатий на кнопку, было бы удобно каждый раз увеличивать значение свойства на единицу (операция add).

Другой пример - вы хотите узнать, какой раздел пользователь посетил первым. Здесь свойство нужно записать только в том случае, если оно еще не установлено (операция set_once).

Сложный формат для установки свойств представляет собой массив из объектов. Каждый объект — атомарная операция над свойством. В объекте три поля: op — операция, key — имя свойства, value — значение Поддерживаются следующие операции:

update_or_create — наиболее часто используемый вариант. Если свойство уже существует, перезаписать
set_once — записать только если свойства не существует
add — добавить заданное значение к свойству (если свойства не существует, перед записью значения оно будет создано со значением 0)
delete — удалить свойство
append — добавить в список
union — добавить в список, если еще не добавлен
exclude — удалить из списка

Примеры:

[
    // Установить значение (если уже существует - обновить)
    {"op": "update_or_create", "key": "my_property", "value": "Hello"},

    // Установить только если свойство не задано
    {"op": "set_once", "key": "my_property", "value": "Hello"},

    // Инкремент, декремент, добавление и вычитание
    {"op": "add", "key": "my_property", "value": "1"},
    {"op": "add", "key": "my_property", "value": "-1"},
    {"op": "add", "key": "my_property", "value": "15"},
    {"op": "add", "key": "my_property", "value": "-53"},

    // Удалить свойство
    {"op": "delete", "key": "my_property", "value": "0"},

    // Добавить элемент в список
    {"op": "append", "key": "my_list_property", "value": "super-element"},

    // Добавить элемент в список только если его там еще нет ("добавить в множество")
    {"op": "union", "key": "my_list_property", "value": "super-element"},

    // Удалить элемент из списка
    {"op": "exclude", "key": "my_list_property", "value": "super-element"},
]

На данный момент максимальное количество элементов в списке — 30 элементов. Элементами списка могут быть только строки.

При использовании append элементы добавляются последовательно. Порядок будет сохранен. При добавлении в список 31-го элемента заранее неизвестно, будет ли добавлен новый элемент (и какой из элементов будет удален перед этим).

При использовании union порядок элементов не сохраняется. Если в списке уже 30 элементов, добавление не гарантируется. Однако, гарантируется, что одинаковых элементов в списке не будет.

Системные свойства пользователя

Все названия свойств, начинающиеся с символа $, считаются системными. Ваши собственные свойства не должны начинаться с символа $.

Разрешено изменять только 3 свойства: $name, $phone, $email. Все остальные системные свойства можно только читать.

В колонке «Название в интерфейсе» — как свойство называется в Carrot quest.

Имя	Название в интерфейсе	Описание
`$active_device_guid`	ID последнего активного устройства	Внутренний идентификатор устройства/браузера, с которого пользователь сейчас активен
`$ip`	IP адрес	IP-адрес пользователя, записанный системой при первом посещении сайта
`$score`	Баллы	Количество score-баллов пользователя
`$sessions`	Сессии	Количество визитов пользователя на сайт
`$device`	Устройство	Устройство пользователя
`$device_type`	Тип устройства	Категория устройства, с которого пользователь заходит на сайт (mobile/ pc)
`$os`	ОС	Операционная система устройства пользователя
`$google_client_ids`	Google Client IDs	Идентификаторы пользователя в Google Analytics
`$latitude`	Географическая широта	Географическая широта пользователя
`$longitude`	Географическая долгота	Географическая долгота пользователя
`$country`	Страна	Страна пользователя, определённая по IP-адресу
`$region`	Регион	Регион пользователя, определённый по IP-адресу
`$city`	Город	Город пользователя, определённый по IP-адресу
`$browser`	Браузер	Браузер, которым пользуется пользователь
`$avatar`	Аватар	Имя файла с аватаром. Аватарки пользователей лежат по адресу: `https://files.carrotquest.io/avatars-users/{{ $avatar }}`
`$initial_referrer`	Первый источник	Сайт или ссылка, с которой пользователь пришёл при самом первом визите
`$initial_referrer_domain`	Первый источник (домен)	Домен сайта-источника первого визита пользователя, без полного адреса страницы
`$last_session_referrer`	Последний источник	Сайт или ссылка, с которой пользователь пришёл в текущей сессии
`$initial_utm_campaign`	Первая метка UTM Campaign	Значение UTM-метки campaign при первом визите пользователя
`$initial_utm_content`	Первая метка UTM Content	Значение UTM-метки content при первом визите
`$initial_utm_medium`	Первая метка UTM Medium	Значение UTM-метки medium при первом визите
`$initial_utm_source`	Первая метка UTM Source	Значение UTM-метки source при первом визите
`$initial_utm_term`	Первая метка UTM Term	Значение UTM-метки term при первом визите
`$last_utm_campaign`	Последняя метка UTM Campaign	Значение UTM-метки campaign в последнем визите
`$last_utm_content`	Последняя метка UTM Content	Значение UTM-метки content в последнем визите
`$last_utm_medium`	Последняя метка UTM Medium	Значение UTM-метки medium в последнем визите
`$last_utm_source`	Последняя метка UTM Source	Значение UTM-метки source в последнем визите
`$last_utm_term`	Последняя метка UTM Term	Значение UTM-метки term в последнем визите
`$last_contacted`	Последний контакт	Последний контакт, дата последнего ответа от пользователя или последней отправки сообщения пользователю (в том числе автосообщения)
`$last_seen`	Последняя активность	Последняя активность, дата совершения последнего события
`$last_reply`	Последний ответ	Дата последней реплики пользователя в диалогах (канал/источник диалога не важен)
`$source`	Источник появления лида	Мессенджер или социальная сеть как источник появления лида
`$name`	Имя	Имя пользователя
`$phone`	Телефон	Номер телефона пользователя
`$email`	Email	Email пользователя
`$name_placeholder`	Имя по умолчанию	Имя пользователя по умолчанию, если настоящее имя неизвестно
`$social_facebook`	Facebook	Ссылка на аккаунт пользователя в Facebook
`$social_instagram`	Instagram	Ссылка на аккаунт пользователя в Instagram
`$social_pinterest`	Pinterest	Ссылка на аккаунт пользователя в Pinterest
`$social_telegram`	Telegram	Ссылка на аккаунт пользователя в Telegram
`$social_twitter`	Twitter	Ссылка на страницу пользователя в Twitter
`$social_vk`	VK	Ссылка на страницу пользователя во ВКонтакте
`$social_whatsapp`	WhatsApp	Ссылка на WhatsApp-аккаунт пользователя
`$social_telegram_id`	Telegram ID	ID пользователя в Telegram
`$social_max_id`	MAX ID	ID пользователя в MAX
`$user_id`	User ID	Уникальный идентификатор пользователя, передаваемый при регистрации или авторизации в личном кабинете
`$user_link`	Ссылка на пользователя	Ссылка на карточку пользователя
`$roistat_visit`	Roistat визит	Идентификатор визита пользователя в Roistat
`$tags`	Список тегов	Теги, присвоенные пользователю
`$phone_storage_is_allowed`	Телефон: согласие на использование	Согласие пользователя на хранение телефона
`$email_storage_is_allowed`	Email: согласие на использование	Согласие пользователя на хранение email
`$data_processing_policy_is_allowed`	Согласие на обработку данных в чате	Согласие пользователя на обработку персональных данных
`$telegram_subscriptions`	Подписка на Telegram-ботов	Боты в Telegram, на которые подписан пользователь
`$max_subscriptions`	Подписка на MAX-ботов	Боты в MAX, на которые подписан пользователь
`$wa_status_by_phone`	Статус аккаунта WhatsApp	Статус телефона пользователя в WhatsApp: Статус наличия WhatsApp-аккаунта на номере телефона: account_exists — если исходящее сообщение доставлено, account_not_registered — если не доставлено с ошибкой message-undeliverable. Проверяется перед автосообщениями и рассылками в WhatsApp.
`$conversations_chats`	Количество диалогов (чат)	Количество диалогов с типом чат
`$conversations_chatbots`	Количество диалогов (чат-бот)	Количество диалогов с ботами
`$conversations_emails`	Количество диалогов (емейл)	Количество диалогов по email
`$conversations_popups`	Количество диалогов (попап)	Количество диалогов с типом поп-ап
`$conversations_pushes`	Количество диалогов (пуш-уведомление)	Количество диалогов через push-уведомления
`$active_device_push_subscribed`	Подписка на Web Push	Признак, что push включён на активном устройстве пользователя
`$push_unsubscribed`	Отписался от push-уведомлений	Признак отписки пользователя от push-уведомлений
`$sdk_push_subscribed`	Отправка Push-уведомлений в SDK разрешена	Отправка push-уведомлений через SDK разрешена
`$sdk_push_notifications_subscribed`	Подписка на мобильные Push: сообщения в чате	Push-уведомления чата через SDK разрешены
`$sdk_push_campaigns_subscribed`	Подписка на мобильные Push: триггерные/ручные сообщения	Push-уведомления рассылок через SDK разрешены
`$banned`	Пользователь заблокирован	Пользователь заблокирован в системе
`$email_status`	Подписка на почтовые рассылки	Статус подписки пользователя на почтовые рассылки: подписан/отписан
`$crm_manager`	CRM: Менеджер	Данные в CRM: имя менеджера, ответственного за сделку
`$crm_successful_contact`	CRM: Успешная связь	Данные в CRM: успешная связь
`$crm_phone`	CRM: Телефон	Данные в CRM: телефон
`$crm_email`	CRM: Email	Данные в CRM: email
`$crm_last_contact_date`	CRM: Дата последней связи	Данные в CRM: дата последней связи
`$crm_sql`	CRM: SQL	Данные в CRM: сделке присвоен статус SQL
`$crm_archive_reason`	CRM: Причина архивации или отказа	Данные в CRM: причина архивации или отказа
`$crm_status`	CRM: Статус	Данные в CRM: на каком этапе (статусе) сделки лид
`$crm_budget`	CRM: Бюджет	Данные в CRM: бюджет сделки
`$retailcrm_id`	RetailCRM ID	Данные в CRM: ID пользователя в RetailCRM
`$bitrix24_id`	Битрикс24 ID	Данные в CRM: ID пользователя в Битрикс24
`$bitrix24_responsible`	Битрикс24 Ответственный	Данные в CRM: менеджер в Битрикс24, ответственный за сделку
`$demo_request_page`	Страница запроса демо	Страница, с которой пользователь оставил заявку на консультацию
`$lead_tier`	Тир лида	Тир (уровень приоритета) лида — используется для маршрутизации и приоритизации обработки
`$mql`	MQL	Лиду присвоен статус MQL — критерии квалификации выполнены
`$mql_source`	Источник MQL	Диалог, в котором лид выполнил критерии MQL-квалификации
`$lead_type`	Тип лида	Классификация или категория лида
`$user_status`	Статус пользователя	Кто пользователь нам сейчас: visitor — ни контакта, ни диалога, engaged — был диалог, контакта нет, lead — есть контакт, user — зарегистрирован, customer — платил хоть раз. Считаем мы из других стандартных свойств, первое совпадение сверху вниз
`$site`	Сайт лида	Сайт компании лида
`$budget`	Бюджет	Бюджет пользователя на покупку
`$goal`	Цель	Цель пользователя
`$role`	Роль	Должность или роль пользователя
`$industry`	Индустрия	Индустрия пользователя
`$experience`	Опыт	Уровень опыта пользователя
`$target_country`	Страна назначения	Целевая страна пользователя
`$booking_slot_datetime`	Бронирование: дата и время слота	Бронирование: дата и время встречи
`$booking_meeting_link`	Бронирование: ссылка на встречу	Бронирование: ссылка на онлайн-встречу
`$booking_manager_id`	Бронирование: ID менеджера	Бронирование: идентификатор менеджера
`$booking_manager_name`	Бронирование: имя менеджера	Бронирование: имя менеджера
`$booking_manager_email`	Бронирование: email менеджера	Бронирование: email менеджера, на которого назначена встреча
`$lead_cost`	Стоимость лида	Стоимость лида

Устаревшие deprecated свойства: $comment, $last_active_user, $online, $idle, $cluster_id, $app_uid, $identity, $carrotquest_registered, $last_instant_message, $vk_id, $facebook_id, $twitter_id, $userlink, $social_foursquare, $social_googleplus, $social_skype, $product, $placement, $subject, $email_unsubscribed, $crm_userlink, $host_meeting_manager, $uid.

После первого совершения события, у пользователя появляются три свойства, связанные с этим событием. Например, если событие имеет ID=123, появятся свойства:

Имя	Описание
`$event_123_count`	Сколько раз было совершено событие
`$event_123_first`	Дата, когда событие было совершено первый раз
`$event_123_last`	Дата, когда событие было совершено последний раз

Свойства для интернет-магазинов

Свойства, специфичные для интернет-магазинов. Эти свойства можно записывать через API.

Имя	Название в интерфейсе	Описание
`$cart_amount`	Сумма в корзине	Текущая сумма продуктов в корзине пользователя (целое число)
`$viewed_products`	Просмотренные продукты	Список продуктов, страницы которых просматривал пользователь
`$cart_items`	Корзина	Список продуктов, которые сейчас находятся в корзине пользователя
`$last_order_status`	Статус последнего заказа	Статус последнего заказа пользователя (например, в обработке, доставлен, отменён)
`$last_payment`	Сумма последнего заказа	Сумма последнего заказа (целое число)
`$revenue`	Сумма всех заказов	Сумма всех заказов (целое число)
`$profit`	Доход с пользователя	Доход с пользователя (целое число)
`$group`	Группа	Группа
`$discount`	Скидка	Скидка (целое число)
`$orders_count`	Количество заказов	Сколько всего заказов сделал пользователь
`$ordered_items`	Заказанные продукты	Список продуктов, которые пользователь когда-либо заказывал
`$ordered_categories`	Категории заказанных продуктов	Список категорий продуктов, которые пользователь когда-либо заказывал
`$viewed_categories`	Категории просмотренных продуктов	Категории просмотренных продуктов (список из названий категорий продуктов)