Получить события пользователя

Этот метод позволяет получить события, которые совершил пользователь.

URL

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

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

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

Параметры

Параметры аутентификации.
Параметры пагинации. Пагинация по первичному ключу объекта Event.
Параметр id_as_string.

Параметр Тип Описание
by_user_id Optional[boolean] Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false
filter_name Optional[строка] Если указать здесь название события, будут возвращены только события этого типа
props_as_string Optional[boolean] Если флаг равен true, то свойства события будут возвращены как строки. По умолчанию: false
app Optional[ID] ID приложения, делающего запрос. По умолчанию определяется на основе токена доступа.

Замечания

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

Ответ

Поле data ответа будет содержать объекты Event.
Поле meta будет содержать новые параметры пагинации.

{
  "meta": {
    "next_before_position": [7936756],
    "status": 200
  },
  "data": [
    {
      "id": 335704586,
      "created": 1467192929,
      "type": {
        "id": 5857,
        "name": "MyEvent",
        "score": 0,
        "visible": true
      },
      "user": 22735768,
      "props": {
        "App": "Eva99"
      }
    },
    ...
  ]
}

Ошибки

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

Примеры

Получить все события пользователя:

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

Получить только события типа MyEventOne:

curl -X GET -H "Authorization: Token XXX" "https://api.carrotquest.io/users/8173131/events?filter_name=MyEventOne"