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

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

URL

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

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

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

Параметры

Параметры аутентификации.
Параметр id_as_string.

Параметр	Тип	Описание
`by_user_id`	Optional[boolean]	Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение `true`. По умолчанию: `false`
`props`	Optional[boolean]	Показывать системные свойства. По умолчанию: `true`
`props_events`	Optional[boolean]	Показывать свойства, связанные с совершенными событиями. По умолчанию: `false`
`props_custom`	Optional[boolean]	Показывать кастомные свойства. По умолчанию: `false`
`presence_details`	Optional[boolean]	Показывать расширенную информацию о статусе пользователя. По умолчанию: `false`
`events`	Optional[boolean]	Показывать свойства, связанные с событиями, в более удобном виде. По умолчанию: `false`
`segments`	Optional[boolean]	Показывать сегменты пользователя. По умолчанию: `false`
`notes`	Optional[boolean]	Показывать заметки о пользователе. По умолчанию: `false`
`tags`	Optional[boolean]	Показывать теги пользователя. По умолчанию: `false`
`email_status`	Optional[boolean]	Показывать статус подписки пользователя на email-ы. По умолчанию: `false`
`convert_props_types`	Optional[boolean]	Если флаг равен `false`, то значения свойств пользователя в полях `props` и `props_custom` ответа возвращаются как строки. По умолчанию: `true`
`timezone_offset`	Optional[boolean]	Показывать ли смещение временной зоны пользователя. По умолчанию: `false`
`app`	Optional[ID]	ID приложения, делающего запрос. По умолчанию определяется на основе токена доступа.

Замечания

Можно заметить, что большая часть параметров запроса, фактически, дублирует поведение включения опциональных полей объекта User, только без префикса include_. Это историческое поведение метода, которое оставлено для обратной совместимости.

Иногда свойства пользователя могут содержать большие числа, которые неверно интерпретируются браузером (см. проблемы с интерпретацией браузером 64-битных чисел). Параметр id_as_string никак не влияет на свойства пользователя. Поэтому для корректной интерпретации таких чисел можно указать параметр convert_props_types=false - тогда все свойства пользователя возвращаются как строки.

Ответ

Поле data будет содержать объект User.

{
  "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": "..."
      },
      ...
    ]
  }
}

Ошибки

Стандартные ошибки Web API.

Пример

curl -X GET -H "Authorization: Token XXX" "https://api.carrotquest.io/users/8173131"