Записать событие

Трекинг (отслеживание) события, которое совершил пользователь.

URL

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

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

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

Параметры

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

Параметр	Тип	Описание
by_user_id	Optional[boolean]	Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false
event	строка[1;255]	Имя события (до 255 символов)
params	Optional[Dict]	Дополнительные свойства события. По умолчанию: {}
created	Optional[timestamp]	UTC timestamp. Время, когда произошло событие. По умолчанию: время выполнения запроса. При отправке этого параметра автособщения планироваться не будут
app	Optional[ID]	ID приложения, в котором создается событие. По умолчанию берется из токена авторизации

Замечания

При записи системных событий, в поле event необходимо указывать системное имя события (начинается со знака $). Посмотреть системные имена событий можно здесь.

Ответ

Ответ в поле data будет содержать созданный объект Event.

{
  "meta": {
    "status": 200
  },
  "data": {
    "id": 6187513,
    "created": 123123123,
    "type": {
      "id": 123123123,
      "name": "testEvent",
      "score": 0,
      "visible": true,
      "active": false
    },
    "user": 123123123,
    "props": {}
  }
}

Ошибки

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

Примеры

Записать событие Order Created у пользователя с CarrotquestId=8173131 (ID из Carrot quest) со свойством item=chicken:

curl -X POST \
  --data-urlencode "event=Order Created" \
  -H "Authorization: Token XXX" \
  https://api.carrotquest.io/users/8173131/events

Записать событие Order Created у пользователя с UserId=user-7216 (ID из вашей системы) со свойством item=chicken:

curl -X POST \
  --data-urlencode "event=Order Created" \
  --data-urlencode 'params={"item": "chicken"}' \
  --data-urlencode "by_user_id=true" \
  -H "Authorization: Token XXX" \
  "https://api.carrotquest.io/users/user-7216/events"