Skip to main content
GET
/
api
/
v1
/
analytics
/
summary
Dashboard Summary
curl --request GET \
  --url https://api.launchmystore.io/api/v1/analytics/summary \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "state": "success",
  "message": null,
  "data": {
    "grossSale": 0,
    "averageOrderValue": 0,
    "conversionRate": 0,
    "avgSalePerDay": 0,
    "avgOrders": 0,
    "totalCustomers": 0,
    "returningCustomers": 0,
    "returningCustomerRate": 0,
    "cancelOrdersCount": 0,
    "canceledOrdersAmount": 0,
    "ordersData": { "totalOrders": 0, "ordersByDay": {} },
    "orderStatusesCount": {},
    "viewDataByDays": 0,
    "viewsByDate": {},
    "sourceCount": {},
    "topProductsByUnitSold": []
  },
  "pagination": null
}
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
{
  "status": 200,
  "state": "success",
  "message": null,
  "data": {
    "grossSale": 0,
    "averageOrderValue": 0,
    "conversionRate": 0,
    "avgSalePerDay": 0,
    "avgOrders": 0,
    "totalCustomers": 0,
    "returningCustomers": 0,
    "returningCustomerRate": 0,
    "cancelOrdersCount": 0,
    "canceledOrdersAmount": 0,
    "ordersData": { "totalOrders": 0, "ordersByDay": {} },
    "orderStatusesCount": {},
    "viewDataByDays": 0,
    "viewsByDate": {},
    "sourceCount": {},
    "topProductsByUnitSold": []
  },
  "pagination": null
}