Conversion Funnel

GET /cdp/insights/funnel computes your brand's browse-to-purchase conversion funnel over a date range from scoped event counts: product_viewed → product_added_to_cart → checkout_started → checkout_completed/order_created. It is the REST twin of the cdp_funnel MCP tool: both return the same stage counts, computed by one shared capability, so the two surfaces cannot drift.

The final stage counts checkout_completed or order_created (whichever your store emits) as a single OR-union. Every stage count is bound to your brand's shop scope — see Tenant Isolation & Scope.

Query parameters

Omit both to compute the funnel over all in-scope events.

Response 200

{
	"stages": [
		{
			"stage": "product_viewed",
			"eventTypes": ["product_viewed"],
			"count": 1000,
			"conversionFromPreviousPct": null,
			"conversionFromStartPct": null,
			"dropOffFromPreviousPct": null
		},
		{
			"stage": "product_added_to_cart",
			"eventTypes": ["product_added_to_cart"],
			"count": 400,
			"conversionFromPreviousPct": 40,
			"conversionFromStartPct": 40,
			"dropOffFromPreviousPct": 60
		},
		{
			"stage": "checkout_started",
			"eventTypes": ["checkout_started"],
			"count": 150,
			"conversionFromPreviousPct": 37.5,
			"conversionFromStartPct": 15,
			"dropOffFromPreviousPct": 62.5
		},
		{
			"stage": "checkout_completed",
			"eventTypes": ["checkout_completed", "order_created"],
			"count": 60,
			"conversionFromPreviousPct": 40,
			"conversionFromStartPct": 6,
			"dropOffFromPreviousPct": 60
		}
	],
	"dateRange": { "from": null, "to": null },
	"scope": "your-shop.myshopify.com"
}

• stages — the four funnel stages in order. Each carries its raw count plus, from the second stage on, conversionFromPreviousPct (vs the previous stage), conversionFromStartPct (vs the first stage), and dropOffFromPreviousPct — all percentages rounded to 2 dp, or null when the denominator is zero (never a divide-by-zero). The first stage is the baseline (all ratios null).
• dateRange — the window echoed back (null bounds when unbounded).
• scope — your brand's resolved shop domain.

Example

curl -s "https://cdp.vyg.app/cdp/insights/funnel?from=2026-06-01&to=2026-06-30" \
  -H "Authorization: Bearer vyg_your_key_here"

Errors