Current Visitors

GET /current_visitors

Try it

Current visitors

cURL

curl --request GET \
  --url https://api.usefathom.com/v1/current_visitors \
  --header 'Authorization: Bearer <token>'

200

{
  "total": 123,
  "content": [
    {
      "pathname": "<string>",
      "hostname": "<string>",
      "total": 123
    }
  ],
  "referrers": [
    {
      "referrer_hostname": "<string>",
      "referrer_pathname": "<string>",
      "total": 123
    }
  ]
}

Returns the total current visitors on the site. Detailed view returns the top 150 pages and top 150 referrers.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

site_id · string · required

The ID of the site.

detailed · boolean · default: false

Set this parameter if you want a detailed breakdown. Otherwise you'll only get a count.

Response

200 - application/json

Current visitor data

total · integer

content · object[]

Show child attributes

content. pathname · string · required

content. hostname · string · required

content. total · integer · required

referrers · object[]

Show child attributes

referrers. referrer_hostname · string · required

referrers. referrer_pathname · string · required

referrers. total · integer · required