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

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

URL

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

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

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

Аргументы

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

Аргумент Описание
auth_token Обязательный. Токен авторизации (нужен scope: user-write)
event Обязательный. Имя события (до 255 символов)
params Необязательный. Дополнительные свойства события. По умолчанию: {}
created Необязательный. UTC timestamp. Время, когда произошло событие. По умолчанию: время выполнения запроса. При отправке этого параметра автособщения планироваться не будут
by_user_id Необязательный. В случае, если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false

Ответ

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

Ответ будет содержать id созданного события.

Примеры

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

curl -X POST \
  --data-urlencode "event=Order Created" \
  --data-urlencode "auth_token=XXX" \
  https://api.carrotquest.io/v1/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" \
  --data-urlencode "auth_token=XXX" \
  "https://api.carrotquest.io/v1/users/user-7216/events"