Get visitors currently online on the site

Get visitors who are currently on the site and are "online". This method is used in LIVE section.

Method is in β and can be altered in the future.

URL

GET https://api.dashly.app/v1/apps/{id}/activeusers

Arguments

This method follows the general rules. Arguments are transmitted as GET or POST parameters.

Argument Description
auth_token Authorization token (requires scope: users-list-active)

Answer

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

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

The answer will contain an array of abbreviated User objects (id, presence and presence_details).

About user status in detail.

Errors

This table contains errors that can be returned. However, in case of unforeseen situations (in case of the service's inoperability), other errors may occur. Always check meta.status parameter.

Error Description
MethodNotAllowed Invalid http method
AuthenticationFailed Invalid (or missing) auth token

Example

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