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

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

URL

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

Параметры

Параметры аутентификации.
Параметры пагинации. Для пагинации v2 допустимо только направления paginate_position=before.
Параметр id_as_string.
Параметры, включающие опциональные поля объекта User. Опциональные поля presence_details, presence, props включены по умолчанию.

Ответ

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

Пример:

{
  "meta": {
    "status": 200
  },
  "data": [
    {
      "id": 184811087,
      "props_Custom": "",
      "presence_details": {
        "page": "Information | My project",
        "url": "http://example.com/some/page.php",
        "session_started": 1448798155,
        "presence": "online",
      }
    },
    ...
  ]
}

Ошибки

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

Примеры

curl -X GET  -H "Authorization: Token XXX" "https://api.carrotquest.io/apps/$self_app/activeusers"