# Store · Management API

> Management API reference for store: GET /sites/{id}/store/overview.

> Markdown version of https://kanorio.com/en/developers/management-api/store. Append `.md` to any developer docs URL for this format. Index: https://kanorio.com/llms.txt · MCP: https://app.kanorio.com/api/mcp

Base URL: `https://app.kanorio.com/api/v1` · [Errors](https://kanorio.com/en/developers/basics/errors) · [Pagination](https://kanorio.com/en/developers/basics/pagination)

### Store overview

`GET /sites/{id}/store/overview`

- Stability: beta
- Permission: `store:view`
- Rate limit: default (120/minute per token)
- MCP tool: `store_overview`

Get store revenue, paid order count, average order value, open conversion funnel (sessions -> product views -> cart -> checkout -> paid orders; direct-buy sections jump straight to checkout without cart) and top selling products for the selected period (thisMonth includes today in the site's timezone so newly paid orders appear immediately; last30d ends yesterday, matching analytics.overview(days=30), since the funnel is sourced from the daily analytics rollup which only covers completed days; lastMonth or custom from/to in YYYY-MM-DD). Errors: FORBIDDEN, VALIDATION.

**Parameters**

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Website id. Get it from sites.list or from sites.create. |
| `range` | query | "thisMonth" \| "lastMonth" \| "last30d" | no | Preset period (defaults to thisMonth; thisMonth includes today in site timezone, last30d ends yesterday; ignored when from and to are provided). |
| `from` | query | string | no | Custom start date (YYYY-MM-DD) in site timezone. |
| `to` | query | string | no | Custom end date (YYYY-MM-DD) in site timezone. |

**Response** (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `currency` | string | yes | Store currency (uppercase ISO 4217, e.g. TWD, USD). |
| `from` | string | yes | Start date (YYYY-MM-DD). |
| `to` | string | yes | End date (YYYY-MM-DD). |
| `totals` | object | yes | — |
| `totals.grossSales` | number | yes | Gross sales before discounts and returns, in minor currency units (same definition as the Store overview dashboard). |
| `totals.totalDiscounts` | number | yes | Discounts applied, in minor currency units. |
| `totals.returns` | number | yes | Refunded amount, in minor currency units. |
| `totals.netSales` | number | yes | Net sales = grossSales - totalDiscounts - returns, in minor currency units. |
| `totals.shippingCharges` | number | yes | Shipping charged to buyers, in minor currency units. |
| `totals.totalSales` | number | yes | Total sales = netSales + shippingCharges, in minor currency units. |
| `totals.orderCount` | integer | yes | Paid order count. |
| `totals.aov` | number | yes | Average order value in minor currency units. |
| `totals.refundRate` | number | yes | Refund rate as a fraction (0-1). |
| `funnel` | object | yes | — |
| `funnel.totalSessions` | integer | yes | Total site sessions. |
| `funnel.productViewSessions` | integer | yes | Sessions that viewed a product. |
| `funnel.cartSessions` | integer | yes | Sessions that added to or viewed the cart (0 when buyers use direct-buy / single-product checkout without a cart). |
| `funnel.checkoutStartedSessions` | integer | yes | Sessions that started checkout (open funnel: can exceed cartSessions when buyers use direct-buy links or single-product checkout sections). |
| `funnel.paidOrders` | integer | yes | Completed paid orders. |
| `topProducts` | object[] | yes | — |
| `topProducts[].productId` | string | yes | Product id. |
| `topProducts[].title` | string | yes | Product title. |
| `topProducts[].quantity` | integer | yes | Units sold. |
| `topProducts[].revenue` | integer | yes | Revenue in minor currency units. |

**Errors**

| Code | Status | When |
| --- | --- | --- |
| `FORBIDDEN` | 403 | — |
| `VALIDATION` | 400 | — |

```bash
curl -X GET "https://app.kanorio.com/api/v1/sites/{id}/store/overview?range=thisMonth" \
  -H "Authorization: Bearer $KANORIO_TOKEN"
```

```json
{
  "currency": "TWD",
  "from": "2026-10-01",
  "to": "2026-10-22",
  "totals": {
    "grossSales": 48600,
    "totalDiscounts": 0,
    "returns": 0,
    "netSales": 48600,
    "shippingCharges": 0,
    "totalSales": 48600,
    "orderCount": 38,
    "aov": 1279,
    "refundRate": 0
  },
  "funnel": {
    "totalSessions": 1420,
    "productViewSessions": 610,
    "cartSessions": 124,
    "checkoutStartedSessions": 62,
    "paidOrders": 38
  },
  "topProducts": [
    {
      "productId": "prod_example01",
      "title": "Strawberry Birthday Cake",
      "quantity": 18,
      "revenue": 21240
    }
  ]
}
```