User

User object (visitor to the site).

One of the major system objects.

Example

{
  "id": 15131846,
  "user_id": "54784",

  "presence": "online",
  "presence_details": {
    ...
  },

  "props": {
    "$name": "Maksim",
    ...
  },

  "props_custom": {
    "project_key": "new-5832-44",
    ...
  },

  "props_events": {
    "$event_123_first": "2015-10-31T14:51:33",
    ...
  },

  "events": [
    {
      "event_type": {
        "id": 7322,
        "name": "My Event",
        "score": 12
      },
      "count": 21,
      "first": 1441105717,
      "last": 1448976199
    },
    ...
  ],

  "segments": [
    {
      "id": 732,
      "name": "segment-reg",
      "filters": "[{\"property_name\":\"$last_seen\",\"cls\":\"dt\",\"type\":\"daysless\",\"value\":{\"value\":\"30\"}}]"
    },
    ...
  ],

  "notes": [
    {
      "id": 954,
      "author": {
        "id": 12711,
        "name": "Maks",
        "avatar": "https://files.dashly.app/avatars/1446185805093-d6o6rtiq.jpg",
        "type": "admin"
      },
      "body": "Cool, bro!",
      "created": 1442675162
    },
    ...
  ],
}

id contains user ID.

presence user status (can be online, idle, offline).

presence_details additional info on user status (only for online or idle). User status description.

props contains system properties (for example: name $name, email $email, sessions count $sessions). System properties description.

props_custom contains custom properties(user properties). Custom property name should not begin with $.

props_events Contains event-driven properties. After user performs an event (for example, event with ID=123), he will obtain 3 properties for this event: $event_123_first (date, when event was first tracked for the user), $event_123_last (date, when event was last tracked for the user) and $event_123_count (number of tracked events with this name).

events Same as props_events but more convenient. event_type — extended information on event (EventType object). first and last - д dates, when the event was first and last tracked (unix timestamp), (unix timestamp), count - number of tracked events with this name.

segments List of segments (Segment object), containing this user. Each segment consists of id, name (segment name) and filters (filters, condition for being in this segment).

notes List of notes (Note object). Administrators can add notes. id contains note id, author is an administrator, who left this note (Admin object), body contains note text, created — date of note creation (unix timestamp).