Skip to main content
GET
Dashboard Summary
Aggregated KPIs for the requested date range — gross sale, orders, customers, returning rate, conversion rate, top products by unit sold. Backs the merchant admin dashboard. Required scope: read_analytics

Query Parameters

range
string
default:"last_7_days"
Predefined range. One of: today, yesterday, last_7_days, last_30_days, last_90_days, this_month, last_month, this_year. Ignored if start and end are provided.
start
string
Custom range start (ISO 8601 / YYYY-MM-DD). Pair with end.
end
string
Custom range end (ISO 8601 / YYYY-MM-DD). Pair with start.

Response

status
number
HTTP status code.
state
string
success or error.
data
object