Skip to main content
GET
Get business overview

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

start_date
string<date>

Start of the date range (inclusive), as an ISO-8601 date (YYYY-MM-DD). Defaults to 7 days before end_date.

end_date
string<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

object
enum<string>
required
Available options:
business_overview
period
object
required

The resolved date range the metrics cover.

previous_period
object
required

The comparison period: the range of equal length immediately before period.start_date.

currency
string
required

Lowercase ISO currency code all monetary amounts are expressed in (the account's display currency).

lifetime_revenue
number
required

All-time revenue in the account currency, in major units (e.g. dollars, not cents) — same units as the revenue series.

revenue
object
required

Period totals with the preceding period of equal length for comparison and a per-day time series.

orders
object
required

Period totals with the preceding period of equal length for comparison and a per-day time series.

leads
object
required

Period totals with the preceding period of equal length for comparison and a per-day time series.

new_customers
object
required

Period totals with the preceding period of equal length for comparison.

refunds
object
required

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
object[]
required

Top products by units sold over the period (units, not revenue — per-item revenue attribution is not tracked). Empty when nothing sold.

traffic
object | null
required

Traffic for the account's live site; null when no site is deployed. Zeros may also mean analytics collection is temporarily degraded.