API 參考

Store

Management API: GET /sites/{id}/store/overview

此頁只有英文版。API 參考、Webhook 事件及變更紀錄維持英文，與程式碼中的欄位名稱、錯誤碼一致。

Base URL https://app.kanorio.com/api/v1Errors Pagination

Store overview

GET/sites/{id}/store/overview

betastore:viewdefault (120/minute per token)

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

idstring · pathrequired
Website id. Get it from sites.list or from sites.create.
range"thisMonth" | "lastMonth" | "last30d" · query
Preset period (defaults to thisMonth; thisMonth includes today in site timezone, last30d ends yesterday; ignored when from and to are provided).
fromstring · query
Custom start date (YYYY-MM-DD) in site timezone.
tostring · query
Custom end date (YYYY-MM-DD) in site timezone.

Response 200

currencystringrequired
Store currency (uppercase ISO 4217, e.g. TWD, USD).
fromstringrequired
Start date (YYYY-MM-DD).
tostringrequired
End date (YYYY-MM-DD).
totalsobjectrequired
totals.grossSalesnumberrequired
Gross sales before discounts and returns, in minor currency units (same definition as the Store overview dashboard).
totals.totalDiscountsnumberrequired
Discounts applied, in minor currency units.
totals.returnsnumberrequired
Refunded amount, in minor currency units.
totals.netSalesnumberrequired
Net sales = grossSales - totalDiscounts - returns, in minor currency units.
totals.shippingChargesnumberrequired
Shipping charged to buyers, in minor currency units.
totals.totalSalesnumberrequired
Total sales = netSales + shippingCharges, in minor currency units.
totals.orderCountintegerrequired
Paid order count.
totals.aovnumberrequired
Average order value in minor currency units.
totals.refundRatenumberrequired
Refund rate as a fraction (0-1).
funnelobjectrequired
funnel.totalSessionsintegerrequired
Total site sessions.
funnel.productViewSessionsintegerrequired
Sessions that viewed a product.
funnel.cartSessionsintegerrequired
Sessions that added to or viewed the cart (0 when buyers use direct-buy / single-product checkout without a cart).
funnel.checkoutStartedSessionsintegerrequired
Sessions that started checkout (open funnel: can exceed cartSessions when buyers use direct-buy links or single-product checkout sections).
funnel.paidOrdersintegerrequired
Completed paid orders.
topProductsobject[]required
topProducts[].productIdstringrequired
Product id.
topProducts[].titlestringrequired
Product title.
topProducts[].quantityintegerrequired
Units sold.
topProducts[].revenueintegerrequired
Revenue in minor currency units.

Errors

FORBIDDEN 403
VALIDATION 400

MCP tool store_overview

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

Response

{
  "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
    }
  ]
}