> ## Documentation Index
> Fetch the complete documentation index at: https://docs.launchmystore.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard Summary

> Get aggregated KPIs for the requested range (sales, orders, customers).

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

<ParamField query="range" type="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.
</ParamField>

<ParamField query="start" type="string">
  Custom range start (ISO 8601 / `YYYY-MM-DD`). Pair with `end`.
</ParamField>

<ParamField query="end" type="string">
  Custom range end (ISO 8601 / `YYYY-MM-DD`). Pair with `start`.
</ParamField>

## Response

<ResponseField name="status" type="number">HTTP status code.</ResponseField>
<ResponseField name="state" type="string">`success` or `error`.</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="summary">
    <ResponseField name="grossSale" type="number">Total gross sales (store currency).</ResponseField>
    <ResponseField name="averageOrderValue" type="number">AOV across the range.</ResponseField>
    <ResponseField name="conversionRate" type="number">Sessions → orders rate (%).</ResponseField>
    <ResponseField name="avgSalePerDay" type="number">Average daily sales.</ResponseField>
    <ResponseField name="avgOrders" type="number">Average daily orders.</ResponseField>
    <ResponseField name="totalCustomers" type="number">Distinct customers.</ResponseField>
    <ResponseField name="returningCustomers" type="number">Customers with prior orders.</ResponseField>
    <ResponseField name="returningCustomerRate" type="number">Returning-customer rate (%).</ResponseField>
    <ResponseField name="cancelOrdersCount" type="number">Orders cancelled in range.</ResponseField>
    <ResponseField name="canceledOrdersAmount" type="number">Cancelled order value.</ResponseField>
    <ResponseField name="ordersData" type="object">`{ totalOrders, ordersByDay }`.</ResponseField>
    <ResponseField name="orderStatusesCount" type="object">Map of status → count.</ResponseField>
    <ResponseField name="viewDataByDays" type="number">Total session/view count.</ResponseField>
    <ResponseField name="viewsByDate" type="object">Map of date → views.</ResponseField>
    <ResponseField name="sourceCount" type="object">Map of traffic source → views.</ResponseField>
    <ResponseField name="topProductsByUnitSold" type="array">Top sellers by units (preview).</ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "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
  }
  ```
</ResponseExample>