User properties

Here you will find various information about the properties of users.

Do not confuse user properties and event properties. The event properties reflect additional information about the event (for example, the "Made an order" event may have the "Sum", "Products" properties, etc.). User properties reflect user information. For example: name, email, number of orders, the sum of all orders, etc.

Data types

5 types are available:

  • number
  • string
  • date/time
  • boolean
  • list

Numbers can only be integers in range from -2^53 to +2^53, or from -9007199254740992 to +9007199254740992.

Maximal string length is 255 characters.

Strings of up to 255 characters can be items of the list (up to 30 items in one list).

Date/time format: ISO 8601: YYYY-MM-DDTHH:MM:SS. Simplified format is acceptable: YYYY-MM-DD, in which case time is set as: 00:00:00.

Example:

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

Property identification formats

Sometimes a simply creating a property is not enough. For example, if you track the number of times a button is clicked, it would be convenient to increment the property value by one each time (add operation).

Another example - you want to know which section the user visited first. Here, the property should be written only if it is not already created (set_once operation).

A complex format for setting properties is an array of objects. Each object is an atomic operation on a property. There are three fields in the object: op - operation, key - property name, value - value. The following operations are supported:

  • update_or_create - most commonly used operation. Creates property (or updates if it already exists)
  • set_once - create only if property does not exist yet
  • add - add a set amount to the property value (if the property does not exist, it will be created with 0 value, and then increased by a set amount)
  • delete - delete property
  • append - add into a list
  • union - add into a list if such item is not already present in the list
  • exclude - delete from the list

Examples:

[
    // Set value (update, if value is already defined)
    {"op": "update_or_create", "key": "my_property", "value": "Hello"},

    // Set if property is undefined
    {"op": "set_once", "key": "my_property", "value": "Hello"},

    // Increment/decrement
    {"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"},

    // Delete property
    {"op": "delete", "key": "my_property", "value": "0"},

    // Add an item into the list
    {"op": "append", "key": "my_list_property", "value": "super-element"},

    // add into a list if such item is not already present in the list ("add to set")
    {"op": "union", "key": "my_list_property", "value": "super-element"},

    // Delete element from the list
    {"op": "exclude", "key": "my_list_property", "value": "super-element"},
]

At the moment lists can contain up to 30 items. Only strings can be items of a list.

In case append is used, items are added sequentially. The order will be preserved. When 31st item is added, defining would a new item be added is impossible(and which item would be removed before adding).

In case union is used order is not preserved. New item insertion is not guaranteed if list already contains 30 items. But not having identical items is guaranteed.

System (standard) user properties

All property names beginning with $ are system. Thus custom properties (those you create) should not begin with $.

Only 3 system properties values can be written. These properties are: $name, $phone, $email. All the rest can only be read.

The "Display name" column shows how the property is named in the Dashly interface.

Name Display name Description
$active_device_guid Last active device ID Internal identifier of the device/browser the user is currently active from
$ip IP address User's IP address, recorded by the system at their first visit
$score Score User's score points
$sessions Sessions Number of the user's visits to the site
$device Device User's device
$device_type Device type Category of the device the user accesses the site from (mobile / pc)
$os OS Operating system of the user's device
$google_client_ids Google Client IDs User's identifiers in Google Analytics
$latitude Latitude User's geographic latitude
$longitude Longitude User's geographic longitude
$country Country User's country, determined by IP address
$region Region User's region, determined by IP address
$city City User's city, determined by IP address
$browser Browser The browser the user is using
$avatar Avatar Name of avatar file. Users avatars are stored here: https://files.dashly.app/avatars-users/{{ $avatar }}
$initial_referrer Initial referrer The site or link the user came from on their very first visit
$initial_referrer_domain Initial referrer (domain) The domain of the referring site from the user's first visit, without the full page address
$last_session_referrer Last referrer The site or link the user came from in the current session
$initial_utm_campaign Initial UTM Campaign UTM campaign value at the user's first visit
$initial_utm_content Initial UTM Content UTM content value at the first visit
$initial_utm_medium Initial UTM Medium UTM medium value at the first visit
$initial_utm_source Initial UTM Source UTM source value at the first visit
$initial_utm_term Initial UTM Term UTM term value at the first visit
$last_utm_campaign Last UTM Campaign UTM campaign value at the last visit
$last_utm_content Last UTM Content UTM content value at the last visit
$last_utm_medium Last UTM Medium UTM medium value at the last visit
$last_utm_source Last UTM Source UTM source value at the last visit
$last_utm_term Last UTM Term UTM term value at the last visit
$last_contacted Last contacted Date of last user’s reply or date when a message to user was last sent (including auto-messages)
$last_seen Last seen Last activity. Date of last event
$last_reply Last reply Date of the user's last reply in conversations (regardless of channel/source)
$source Lead source Messenger or social network as the lead's source of appearance
$name Name User's name
$phone Phone number User's phone number
$email Email User's email
$name_placeholder Name placeholder Default user name, used if the real name is unknown
$social_facebook Facebook Link to the user's Facebook account
$social_instagram Instagram Link to the user's Instagram account
$social_pinterest Pinterest Link to the user's Pinterest account
$social_telegram Telegram Link to the user's Telegram account
$social_twitter Twitter Link to the user's Twitter page
$social_vk VK Link to the user's VKontakte page
$social_whatsapp WhatsApp Link to the user's WhatsApp account
$social_telegram_id Telegram ID User's ID in Telegram
$social_max_id MAX ID User's ID in MAX
$user_id User ID Unique user identifier, passed on registration or sign-in in the personal dashboard
$user_link User link Link to the user's card
$roistat_visit Roistat visit User's visit identifier in Roistat
$tags Tag list Tags assigned to the user
$phone_storage_is_allowed Phone: storage consent User's consent to store their phone number
$email_storage_is_allowed Email: storage consent User's consent to store their email
$data_processing_policy_is_allowed Chat data processing consent User's consent to processing of personal data
$telegram_subscriptions Telegram bot subscriptions Telegram bots the user is subscribed to
$max_subscriptions MAX bot subscriptions MAX bots the user is subscribed to
$wa_status_by_phone WhatsApp account status WhatsApp account status by phone number: account_exists — if the outgoing message was delivered, account_not_registered — if delivery failed with a message-undeliverable error. Checked before autosend messages and WhatsApp broadcasts.
$conversations_chats Conversations (chat) Number of conversations of type chat
$conversations_chatbots Conversations (chat bot) Number of conversations with bots
$conversations_emails Conversations (email) Number of conversations by email
$conversations_popups Conversations (pop-up) Number of conversations of type pop-up
$conversations_pushes Conversations (Web Push) Number of conversations via push notifications
$active_device_push_subscribed Web Push subscription Indicates push is enabled on the user's active device
$push_unsubscribed Unsubscribed from push Indicates the user unsubscribed from push notifications
$sdk_push_subscribed SDK push sending allowed Sending push notifications via SDK is allowed
$sdk_push_notifications_subscribed Mobile push subscription: chat messages Chat push notifications via SDK are allowed
$sdk_push_campaigns_subscribed Mobile push subscription: triggered/manual messages Broadcast push notifications via SDK are allowed
$banned User blocked User is blocked in the system
$email_status Email newsletter subscription User's subscription status for email newsletters: subscribed/unsubscribed
$crm_manager CRM: Manager Data from CRM: name of the manager responsible for the deal
$crm_successful_contact CRM: Successful contact Data from CRM: successful contact
$crm_phone CRM: Phone Data from CRM: phone
$crm_email CRM: Email Data from CRM: email
$crm_last_contact_date CRM: Last contact date Data from CRM: date of the last contact
$crm_sql CRM: SQL Data from CRM: the deal was assigned SQL status
$crm_archive_reason CRM: Archive/decline reason Data from CRM: reason for archiving or decline
$crm_status CRM: Status Data from CRM: which stage (status) of the deal the lead is at
$crm_budget CRM: Budget Data from CRM: deal budget
$retailcrm_id RetailCRM ID Data from CRM: user's ID in RetailCRM
$bitrix24_id Bitrix24 ID Data from CRM: user's ID in Bitrix24
$bitrix24_responsible Bitrix24 Responsible Data from CRM: manager in Bitrix24 responsible for the deal
$demo_request_page Demo request page The page from which the user submitted a consultation request
$lead_tier Lead tier Lead's tier (priority level) — used for routing and prioritizing handling
$mql MQL Lead was assigned MQL status — qualification criteria met
$mql_source MQL source Conversation in which the lead met the MQL qualification criteria
$lead_type Lead type Classification or category of the lead
$user_status User status Who the user is to us right now: visitor — no contact and no conversation, engaged — had a conversation but no contact, lead — contact known, user — registered, customer — has paid at least once. Calculated by us from other standard properties, first match top-down
$site Lead's site Website of the lead's company
$budget Budget User's budget for the purchase
$goal Goal User's goal
$role Role User's job title or role
$industry Industry User's industry
$experience Experience User's level of experience
$target_country Target country User's target country
$booking_slot_datetime Booking: slot date and time Booking: date and time of the meeting
$booking_meeting_link Booking: meeting link Booking: link to the online meeting
$booking_manager_id Booking: manager ID Booking: manager identifier
$booking_manager_name Booking: manager name Booking: manager name
$booking_manager_email Booking: Manager email Booking: email of the manager the meeting is assigned to
$lead_cost Lead cost Cost of the lead

Deprecated properties: $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, $company_name, $uid.

After user performs an event(for example, event with ID=123), he will obtain 3 properties for this event:

Name Description
$event_123_count Number of performances
$event_123_first Date, when event was first performed by the user
$event_123_last Date, when event was last performed by the user

E-commerce properties

E-commerce specific properties. These properties can be identified via API.

Name Display name Description
$cart_amount Cart amount Current total of items in the user's cart (integer)
$viewed_products Viewed products List of products whose pages the user viewed
$cart_items Cart items List of items currently in the user's cart
$last_order_status Last order status Status of the user's last order (e.g. processing, delivered, cancelled)
$last_payment Last payment amount Amount of the last order (integer)
$revenue Revenue Total amount of all orders (integer)
$profit Profit Revenue from the user (integer)
$group Group Group
$discount Discount Discount (integer)
$orders_count Orders count Total number of orders the user has placed
$ordered_items Ordered items List of products the user has ever ordered
$ordered_categories Ordered categories List of product categories the user has ever ordered
$viewed_categories Viewed categories Categories of viewed products (list of category names)