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

string
default:"last_7_days"
Predefined range. One of: today, yesterday, this_week, last_7_days (alias 7d), last_week, this_month (alias 30d), last_month, lifetime (alias 90d), custom. (1d is also accepted as an alias for today.) Ignored if start and end are provided.
string
Custom range start (ISO 8601 / YYYY-MM-DD). Pair with end.
string
Custom range end (ISO 8601 / YYYY-MM-DD). Pair with start.

Response

number
HTTP status code.
string
success or error.
object