Получить данные о пользователе

Этот метод позволяет получить все данные о пользователе.

URL

GET https://api.carrotquest.io/v1/users/{id}

В качестве {id} можно использовать:

  • ID из нашей системы
  • Ваш User ID (укажите параметр by_user_id=true). Если пользователя с таким идентификатором не существует, будет возвращена ошибка

Аргументы

Этот метод следует общим правилам. Аргументы передаются как GET или POST параметры.

Аргумент Описание
auth_token Обязательный. Токен авторизации (нужен scope: user-read)
by_user_id Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false
props Показывать системные свойства. По умолчанию: true
props_events Показывать свойства, связанные с совершенными событиями. По умолчанию: false
props_custom Показывать кастомные свойства. По умолчанию: false
presence_details Показывать расширенную информацию о статусе. По умолчанию: false
events Показывать свойства, связанные с событиями, в более удобном виде. По умолчанию: false
segments Показывать сегменты пользователя. По умолчанию: false
notes Показывать заметки о пользователе. По умолчанию: false
tags Показывать теги пользователя. По умолчанию: false
email_status Показывать статус подписки пользователя на email-ы. По умолчанию: false
convert_props_types Конвертировать тип данных свойств пользователя на основе содержимого. По умолчанию: true

Ответ

{
  "meta": {
    "status": 200
  },
  "data": {
    "id": 96,
    "app": 1,

    "user_id": "124",

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

    "props": {
      "$name": "sdsd",
      "$email": "materkov@gmail.com",
      "$sessions": 50,
      ...
    },
    "props_events": {
      "$event_31_first": "2015-12-10T08:20:23",
      "$event_31_first": "2015-12-16T10:45:13",
      "$event_31_count": 1,
      ...
    },
    "props_custom": {
      "dao1": "value2",
      "dao2": ["9", "18", "21"],
    },

    "events": [
      {
        "first": 1450262713,
        "last": 1450265101,
        "count": 10,
        "event_type": {
          "id": 31,
          "name": "event4",
          "score": 10
        }
      },
      ...
    ],

    "notes": [
      ...
    ],

    "segments": [
      {
        "id": 4,
        "app": 1,
        "name": "Has name",
        "filters": "..."
      },
      ...
    ]
  }
}

Возвращает объект User.

По умолчанию возвращаются только базовые данные: id, app, user_id, presence, props.

Для получения расширенных полей (props_events, props_custom, events, presence_details, notes, segments, tags, email_status) нужно поставить true в одноименных аргументах.

Примеры

curl -X GET https://api.carrotquest.io/v1/users/8173131?auth_token=XXX