latestOpenAPI 3.1.02026-08-1021368.3 KB

50679caad756

Reports

Current visitors

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

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