User

Объект "пользователь" (пользователь сайта).

Это один из основных объектов в системе.

Пример

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

  "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.carrotquest.io/avatars/1446185805093-d6o6rtiq.jpg",
        "type": "admin"
      },
      "body": "Cool, bro!",
      "created": 1442675162
    },
    ...
  ],
}

id показывает ID пользователя.

user_id строковый идентификатор пользователя в приложении, уникальный для магазина. По нему производится склейка пользователей.

removed это дата удаления пользователя. Пользователь может быть удален в результате склейки или полного удаления (GDPR). Если пользователь не удален, возвращает null.

presence это статус пользователя (может быть online, idle, offline).

presence_details это дополнительная информация о статусе пользователя (есть только у тех, кто online или idle). Описание статусов пользователя.

props содержит системные свойства (например: имя $name, емейл $email, количество сессий $sessions). Описание системных свойств.

props_custom содержит кастомные свойства пользователя. Кастомные свойства не могут начинаться с символа $.

props_events содержит свойства, связанные с событиями. После того, как пользователь совершит событие (например, событие с ID=123), у него появятся три свойства:

  • $event_123_first — дата, когда событие было совершено первый раз
  • $event_123_last — дата, когда событие было совершено последний раз
  • $event_123_count — сколько раз было совершено событие

Опциональные поля (включаются в объект, если указаны параметры запроса на получение доп. опций): segments это список объектов Segment, в которые входит пользователь.

notes это список заметок объектов Note. Заметки могут добавлять администраторы.

tags список объектов UserTag.

email_status объект со статусом подписки пользователя на email-рассылки: объект EmailStatus Если email у пользователя не задан, возвращает null.

events содержит те же данные, что и props_events, но в более удобном виде:

  • event_type — расширенная информация о событии: объект EventType
  • first, last — даты, когда событие было совершено в первый и последний раз (Unix timestamp)
  • count — сколько раз было совершено событие