Skip to main content
GET
Home > Live "Where they are" card (visitors by country right now)

Authorizations

Authorization
string
header
required

Bearer token authentication. Requires a company-admin token whose role holds reports.view. Additionally, the caller's company must have ANALYTICS_DASHBOARD enabled — otherwise every endpoint returns 404.

Query Parameters

country
string

ISO alpha-2 code of one of the requesting company's configured countries (see GET /countries). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send "all") for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return 400.

Example:

"US"

Response

Where-they-are payload

Home > Live "Where they are" card (Card 6). Ranked list of countries with visitors on the site right now, plus the total online count across all countries. Same 5-minute trailing window as the visitors-now header tile and Top Pages card so counts stay consistent across the tab. online_total is the sum across ALL countries in the window, not just the top-N countries returned.

countries
object[]
required
Maximum array length: 6
online_total
integer
required
Required range: x >= 0
meta
object