Профиль объекта

Этот эндпоинт необязателен и полезен для получения полной картины о пользователе, просто взглянув на его профиль.

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

---

Добавление свойств к профилю

POST https://api.getloglee.ru/rest/v1/rpc/identify

Хэдеры

Название	Тип	Описание
Content-Type *	String	application/json
Authorization *	String	Bearer <Личный API-токен>
apikey *	String	<Публичный API-токен>

Тело запроса

Название	Тип	Описание
object_name *	String	Название профиля объекта
object_project_id *	String	Айди проекта
object_properties *	JSON	Свойства профиля в формате key-value

Важно: Поля, оканчивающиеся на *, обязательны для заполнения!

Ответ

{
  "id": "9d18784c-9b0d-4992-88ba-12345678",
  "name": "user-123",
  "created_at": "2024-09-02T08:20:03.289585",
  "project_id": "c461c846-8171-419a-a07b-12345678",
  "properties": {
    "plan": 0.2,
    "country": "Kazakhstan"
  }
}

---

Использование метода

Важно помнить, что ключи свойств перезаписываются. Например, представьте, что пользователи нашего продукта сначала пользуются бесплатной пробной версией, а затем переходят на платный тарифный план. Мы хотим отслеживать тарифный план, который в данный момент закреплен за пользователем, и другие параметры, такие как его имя и адрес электронной почты. Мы можем сделать это, вызвав эндпоинт Identify после регистрации пользователя.

{
  "object_name": "user-123",
  "project_id": "c461c846-8171-419a-a07b-12345678",
  "properties": {
    "plan": "free",
    "name": "John Doe",
    "email": "[e-mail]",
    "username": "johndoe"
  }
}

Позже, когда пользователь перейдет на платный тарифный план, мы сможем снова вызвать энпоинт Identify с новым значением тарифного плана:

{
  "object_name": "user-123",
  "project_id": "c461c846-8171-419a-a07b-12345678",
  "properties": {
    "plan": "premium"
  }
}

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

{
  "id": "9d18784c-9b0d-4992-88ba-12345678",
  "name": "user-123",
  "created_at": "2024-09-02T08:20:03.289585",
  "project_id": "c461c846-8171-419a-a07b-12345678",
  "properties": {
    "plan": "premium",
    "name": "John Doe",
    "email": "[e-mail]",
    "username": "johndoe"
  }
}

Обратите внимание, что ключи свойств могут содержать только строчные буквы.

Значения могут быть любыми: строковыми, логическими или числовыми.