Получить онлайн-пользователей на сайте

Получить пользователей, которые в данный момент находятся на сайте со статусом "онлайн". Мы используем этот метод на странице LIVE.

Метод находится в статусе β и может быть изменен в будущем.

URL

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

Аргументы

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

Аргумент Описание
auth_token Токен авторизации (нужен scope: users-list-active)

Ответ

{
  "meta": {
    "status": 200
  },
  "data": [
    {
      "id": 184811087,
      "presence": "online",
      "presence_details": {
        "$name": "Maks",
        "$initial_referrer": "",
        "$country": "Russia",
        "$region": "Moscow",
        "$city": "Moscow",
        "$sessions": 3,

        "$current_page_title": "Information | My project",
        "$current_page_url": "http://example.com/some/page.php"
        "$active_since": 1448798155,
        "$current_session_pages": 3,
      }
    },
    ...
  ]
}

Ответ будет содержать массив с сокращенными объектами User (только id, presence и presence_details).

Подробнее о статусах пользователей

Ошибки

Эта таблица содержит ошибки, которые могут быть возвращены. Однако, в случае непредвиденных ситуаций ввиду неработоспособности сервиса могут возникнуть другие ошибки. Всегда следует проверять параметр meta.status.

Ошибка Описание
MethodNotAllowed Неверный HTTP-метод
AuthenticationFailed Токен авторизации неверен (или отсутствует)

Примеры

curl -X GET \
  'https://api.carrotquest.io/v1/apps/$self_app/activeusers?auth_token=XXX'