Storefront funnel
get_storefront_funnelThe web's funnel from Shopify's sessions, in total and on mobile and desktop, against the comparison period: sessions, purchases, and each step's rate in both (addToCart, cartToCheckout, checkoutToPurchase, conversion; changePoints already in points), with stepThatFellMost. A previous figure of null means no sessions recorded then, not zero. byPageType is the current period per kind of landing page. sessionsByChannel is GA4's sessions per traffic channel in both periods, empty with no GA4: use it for where traffic came from, as its total differs from Shopify's. Use for conversion by device, where visitors drop off and where the traffic came from. Optional from and to (inclusive YYYY-MM-DD, both or neither, never after today) read another span instead of the default period. A named month, a week or two dates the operator gave MUST be sent here: without them this reads the last 30 days, which is not that month.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day of the span, inclusive, as YYYY-MM-DD; not after today. Send together with `from`, or omit both to read the default 30-day period. | |
| from | No | First day of the span, inclusive, as YYYY-MM-DD. Send together with `to`, or omit both to read the default 30-day period. | |
| compare | No | What to compare the span with: previous (default, the same number of days just before), yoy (the same dates last year) or yoyWeekday (52 weeks back, the same weekdays — use it for natural Monday–Sunday weeks or whenever the operator says 'last year' over weeks). | |
| compareTo | No | Last day of the named comparison period, YYYY-MM-DD. | |
| compareFrom | No | First day of a NAMED comparison period, YYYY-MM-DD, with compareTo. For 'September with October': from/to October, compareFrom/compareTo the whole of September. Takes the place of compare. |