Sign in
Web Analytics

Get the checkout page-view order funnel

Counts eligible checkout page views, views with linked orders, views with linked paid orders, and distinct linked orders. Later creation/payment can update the original view cohort. Missing links and unknown eligibility are not reconstructed from operational orders. Requires web_analytics:read. The authenticated credential determines the business; no business_id override is accepted. Reporting and scope-option calls share a 600-request/hour limit per API key or OAuth installation, in addition to the normal burst and hourly limits. Responses contain recorded analytics, which may be lower than actual traffic because of consent choices, self-traffic exclusion, blockers, and unavailable attribution.

get/v3/web-analytics/order-funnel

Query parameters

fromstring date required

Inclusive start date in the requested timezone. from must be on or before to; the inclusive range cannot exceed 180 days.

tostring date required

Inclusive end date in the requested timezone. Raw event history is retained for 180 days; expired data is not reconstructed.

timezonestring

Recognized IANA timezone used for date boundaries and daily buckets.

store_idinteger

Optional store owner filter within the authenticated business. Use /v3/web-analytics/stores to obtain IDs without operational store permissions.

entity_type'landing_page' | 'product' | 'bundle_price_option' | 'store_home' | 'cart' | 'checkout' | 'payment_link' | 'order_detail' | 'order_success' | 'order_invoice'

Customer-facing page surface. The owner is a landing page, product, bundle price option, store, or protected payment-link scope; order surfaces use the store owner, never an order ID.

Optional surface filter. A type alone selects every owner of that surface. Supply entity_id to narrow to one owner; invalid types are errors.

entity_idstring

Requires entity_type. Positive numeric owning IDs are sent as text; store_home/cart/checkout/order_detail/order_success/order_invoice use store IDs. For payment_link use the opaque plscope_ identifier from /v3/web-analytics/payment-links. A malformed nonempty ID is an error, not an unfiltered report.

entity_pathstring

Optional sanitized fallback path for records without a stored entity identity. Requires entity_type (or legacy page_id); use with entity_id. It does not replace the independent page_path filter. Payment-link scope ignores fallback paths.

page_idinteger

Legacy alias for entity_type=landing_page and entity_id. Cannot be combined with entity_type or entity_id.

page_hoststring

Optional hostname filter. Host, path and entity compose independently; host also restricts the navigation universe for journeys.

page_pathstring

Optional exact sanitized path filter across hosts. Use / for the homepage. An explicitly empty value does not mean unfiltered. For journeys/funnels this selects the focus while retaining neighbouring pages.

ad_click'paid' | 'organic' | 'meta' | 'google' | 'tiktok'

Filter by recorded ad-click evidence or network, independent of UTM labels. organic means no captured click ID, not proof of unpaid acquisition. Unrecognized values are ignored by the server; use one of the documented values.

limitinteger

Maximum ranked rows for reports that return ranked lists. Values above 100 are capped at 100; absent or invalid/non-positive values use 25. This is not cursor pagination and does not cap range totals or the fixed audience-location caps.

Response

Success

visitorsinteger required

Identified visitors among eligible checkout page views.

viewsinteger required

Eligible page views capable of creating an order; UI label: Checkout page views.

unknown_eligibility_viewsinteger required

Legacy landing-page views whose order capability was not recorded.

excluded_viewsinteger required

Known ineligible page views.

denominator_basis'order_capable_pageviews' required
views_with_orderinteger required

Eligible page views with at least one linked order; each view counts once.

views_with_paid_orderinteger required

Eligible page views with at least one linked paid order; each view counts once.

orders_createdinteger required

Distinct linked orders, which can exceed views_with_order.

orders_paidinteger required

Distinct linked orders with an observed paid transition.

linked_order_counts_onlytrue required
basis'page_view_cohort' required

Changes

Changed in 1 of the 7 revisions of this API.1