---
title: "Get the checkout page-view order funnel"
method: GET
path: "/v3/web-analytics/order-funnel"
tags: ["Web Analytics"]
---

# Get the checkout page-view order funnel

`GET /v3/web-analytics/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.

## Query parameters

- `from` string, date, required
- `to` string, date, required
- `timezone` string
- `store_id` integer
- `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.
- `entity_id` string
- `entity_path` string
- `page_id` integer
- `page_host` string
- `page_path` string
- `ad_click` 'paid' | 'organic' | 'meta' | 'google' | 'tiktok'
- `limit` integer

## Response `200`

Success

- WebAnalyticsOrderFunnel — Dates and filters select the originating eligible page-view cohort. Later linked orders and payments update that cohort within 180-day retained history. This is not all operational orders or current net-paid status after refunds. Unknown/ineligible views and unverifiable links are excluded; do not reconstruct them from current catalog settings.
  - `visitors` integer, required — Identified visitors among eligible checkout page views.
  - `views` integer, required — Eligible page views capable of creating an order; UI label: Checkout page views.
  - `unknown_eligibility_views` integer, required — Legacy landing-page views whose order capability was not recorded.
  - `excluded_views` integer, required — Known ineligible page views.
  - `denominator_basis` 'order_capable_pageviews', required
  - `views_with_order` integer, required — Eligible page views with at least one linked order; each view counts once.
  - `views_with_paid_order` integer, required — Eligible page views with at least one linked paid order; each view counts once.
  - `orders_created` integer, required — Distinct linked orders, which can exceed views_with_order.
  - `orders_paid` integer, required — Distinct linked orders with an observed paid transition.
  - `linked_order_counts_only` true, required
  - `basis` 'page_view_cohort', required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. Storefront public requests using `X-Scalev-Storefront-Api-Key` or `X-Scalev-Guest-Token` are rate-limited as direct client/browser requests. Machine-authenticated business requests are rate-limited per API key or OAuth installation. Rate-limit responses may be plain text instead of the normal JSON error shape.

## Changes

- **2026-09-20** `af4231e0cad9` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/scalev/apis/nexus-commerce-api/changes/v3/web-analytics/order-funnel/get.md)

---

[API](https://skmtc.dev/scalev/apis/nexus-commerce-api.md) · [All operations](https://skmtc.dev/scalev/apis/nexus-commerce-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scalev/apis/nexus-commerce-api/revisions/215156c4eee0?raw)