Home > Live header tiles (visitors now, revenue today, orders today, reps active)
Returns the four tiles at the top of the Home > Live tab plus the vs-typical delta the Revenue-today tile shows. The tab polls this endpoint on a short cadence (~15 s), so every query is bounded (five-minute visitor window, store- local calendar day for revenue / orders / reps).
Authorizations
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
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.
"US"
Response
Live-header card payload
Four tiles that sit above the Home > Live intraday chart: visitors on the site right now, revenue and orders on the store-local calendar day, and reps active today. The vs-typical delta shows how today's revenue-so-far compares to the average of the trailing twelve same-weekday dates at this same wall-clock instant.
Distinct bot-free sessions in the trailing five minutes.
x >= 0Thirty one-minute buckets of distinct-session counts, oldest → newest. Zero-filled for quiet minutes so the chart's x-axis stays uniform across polls.
30 elementsx >= 0Decimal amount, expressed as a string to preserve arbitrary
precision across the wire. Parsed to Number on the client and
formatted with Intl.NumberFormat. Once the in-flight
money-cents-migration lands, this will switch to a
{ amount_cents: integer, currency: string } object.
"180.25"
x >= 0Distinct member ids that either closed a sale or fired a share-attributed visit on the store-local calendar day.
x >= 0Decimal amount, expressed as a string to preserve arbitrary
precision across the wire. Parsed to Number on the client and
formatted with Intl.NumberFormat. Once the in-flight
money-cents-migration lands, this will switch to a
{ amount_cents: integer, currency: string } object.
"180.25"
Decimal amount, expressed as a string to preserve arbitrary
precision across the wire. Parsed to Number on the client and
formatted with Intl.NumberFormat. Once the in-flight
money-cents-migration lands, this will switch to a
{ amount_cents: integer, currency: string } object.
"180.25"
ISO 4217 three-letter code (uppercase).
3"USD"