Get business overview
Account-wide business pulse in one call: revenue, orders, leads, new customers, and live-site traffic over a date range, each compared against the immediately preceding period of equal length. Defaults to the last 7 days; the range cannot exceed 366 days. Use this as the starting point for any business review — drill into a specific site with GET /sites//analytics, and into records with the orders/customers list endpoints.
Authorizations
API key in the format: Bearer {api_token}
Query Parameters
Start of the date range (inclusive), as an ISO-8601 date (YYYY-MM-DD). Defaults to 7 days before end_date.
End of the date range (inclusive), as an ISO-8601 date (YYYY-MM-DD). Defaults to today.
Response
Business overview for the requested period
business_overview The resolved date range the metrics cover.
The comparison period: the range of equal length immediately before period.start_date.
Lowercase ISO currency code all monetary amounts are expressed in (the account's display currency).
All-time revenue in the account currency, in major units (e.g. dollars, not cents) — same units as the revenue series.
Period totals with the preceding period of equal length for comparison and a per-day time series.
Period totals with the preceding period of equal length for comparison and a per-day time series.
Period totals with the preceding period of equal length for comparison and a per-day time series.
Period totals with the preceding period of equal length for comparison.
Orders created in the period that have since been refunded or partially refunded. Attribution is by order date (refund timestamps are not tracked); amounts are in the account currency (major units).
Top products by units sold over the period (units, not revenue — per-item revenue attribution is not tracked). Empty when nothing sold.
Traffic for the account's live site; null when no site is deployed. Zeros may also mean analytics collection is temporarily degraded.

