USusefathom
Reports

Current visitors

Changed on

Returns the total number of current visitors on a site. The detailed view also returns the top 150 pages and top 150 referrers.

Permissions: Requires read access to the site (all-sites-readonly, read:{site_id} or manage:{site_id}).

Returns: The current visitor count, with an optional detailed breakdown.

get/current_visitors

Request

  • Base URL
    https://api.usefathom.com/v1
  • URL
    https://api.usefathom.com/v1/current_visitors
  • Auth
    HTTP bearer

Query parameters

site_idstring required
Example:CDBUGS

The id of the site. Example: CDBUGS

detailedboolean

Set to true for a detailed breakdown of pages and referrers. Otherwise you'll only get a count.

Response

Simple

Changes

  • 50679caad756Revision changes
    • info

      api operation id currentVisitors was added

    • info

      api tag Reports added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status