Read where buyers stop on the payment page
get_checkout_funnelShows where buyers stop during payment for invoices created in a chosen period by counting invoice stage progression, helping identify payment drop-off.
Instructions
Gets where buyers stop on the payment page for the invoices created in a period. Needs a store key (npx stablevoy-mcp login). It counts invoices, not visits: how many were opened (on the hosted page or in the widget), had the network or token changed, had the details copied, started a wallet, were refused or failed in the wallet, had a transaction sent, saw a payment (detected) and were paid. Nothing about the buyer is kept. A buyer who pays from another device skips page steps, so read it as a guide. Pass either period or both createdFrom and createdTo as UTC days, at most 92 days per call. A period together with dates, or only one date, is refused. Without store and with several stores you get one funnel per store plus a total. Use get_checkout_trail for the steps of one invoice and summarize_payments for the money. The API allows 30 calls a minute per store. A failure comes back as an error with its code and what to do, for example rate_limited with the seconds to wait.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_checkout_funnel"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| store | No | Store id or exact store name from list_stores. Needed only when several stores are connected. | |
| period | No | A ready-made range of UTC days ending today. Leave out when giving dates. | |
| createdTo | No | Last UTC day, YYYY-MM-DD, included. | |
| createdFrom | No | First UTC day, YYYY-MM-DD, with createdTo. |