Skip to main content
GET
Home > Live header tiles (visitors now, revenue today, orders today, reps active)

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

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.

visitors_now
integer
required

Distinct bot-free sessions in the trailing five minutes.

Required range: x >= 0
visitors_sparkline
integer[]
required

Thirty one-minute buckets of distinct-session counts, oldest → newest. Zero-filled for quiet minutes so the chart's x-axis stays uniform across polls.

Required array length: 30 elements
Required range: x >= 0
revenue_today
string
required

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.

Example:

"180.25"

orders_today
integer
required
Required range: x >= 0
reps_active_today
integer
required

Distinct member ids that either closed a sale or fired a share-attributed visit on the store-local calendar day.

Required range: x >= 0
typical_revenue
string
required

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.

Example:

"180.25"

delta_vs_typical
string
required

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.

Example:

"180.25"

currency
string
required

ISO 4217 three-letter code (uppercase).

Required string length: 3
Example:

"USD"

meta
object