Get order stats
get_order_statsUse this tool when the user asks how many orders or how much revenue their Convika pages brought, which page sells best, or which source or campaign brings orders: 「どのページが一番売れてる?」「Instagram からの注文は?」「今月の売上」「ChatGPT から来た注文は?」.
Returns the orders and revenue in the period, by page and by traffic source (the source an order recorded from the page view that led to it: UTM source, medium, or campaign, or the referring site; "(none)" when it had none). byArrival splits the same orders into those whose buyer came from an AI assistant (ai, and assistants: each assistant by name, one of "chatgpt.com", "perplexity.ai", "claude.ai", "gemini.google.com", "copilot.microsoft.com", "grok.com", "chat.deepseek.com", "meta.ai") and the rest (other), from the link's utm_source or the referring site of the page view that led to the order. It counts orders placed (not test, spam, duplicates, or declined, cancelled, refunded, or unpaid card orders); revenue counts paid orders (cash on delivery once accepted), less refunds. Amounts are in the currency's main unit as text.
Orders hold no visitor id, so they aren't joined to visitors: for a page with an "order" goal, conversion totals in the analytics tools are estimates (conversionsEstimated). For traffic and orders by source side by side, use analyze_source_quality.
On Free, counts and totals include the first 50 cash-on-delivery, bank-transfer, and payment-link orders of each UTC month; orders past that aren't counted (get_orders still lists them), omittedOverCap says how many, and the dashboard's Orders page lists them all. Pro and above have no cap. startDate and endDate are whole days (YYYY-MM-DD) in timeZone, UTC when left out; leave both out for all time.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | No | Only this page. Leave out for every page. | |
| endDate | No | Last day, YYYY-MM-DD | |
| timeZone | No | IANA time zone name for the days in this response, such as America/New_York, Europe/Berlin, or Asia/Tokyo. Leave it out for the workspace's time zone (UTC when none is set). It affects only this response: the workspace's time zone stays as it is, and only the workspace's owner changes it, in the dashboard's Settings. Abbreviations such as EST and offsets such as +09:00 aren't accepted. | |
| startDate | No | First day, YYYY-MM-DD | |
| sourceDimension | No | What bySource groups by. Defaults to utm_source. | utm_source |