---
title: "Quiz completion funnel"
method: GET
path: "/v1/quizzes/{quiz_id}/analytics/funnel"
tags: ["analytics"]
---

# Quiz completion funnel

`GET /v1/quizzes/{quiz_id}/analytics/funnel`

## Request

- Base URL: `https://api.octaneai.com`
- URL: `https://api.octaneai.com/v1/quizzes/{quiz_id}/analytics/funnel`
- Auth: HTTP bearer

## Path parameters

- `quiz_id` string, required

## Query parameters

- `from` string, date, nullable: First day, inclusive, in tz; 29 days before `to` when absent
- `to` string, date, nullable: Last day, inclusive, in tz; today when absent
- `tz` string
- `channel` string, nullable
- `device` string, nullable
- `new_returning` string, nullable
- `country` string, nullable

## Headers

- `if-none-match` string, nullable

## Response `200`

Analytics for the range. ETag identifies the cached response.

- AnalyticsFunnel
  - `quiz_id` string, required
  - `range` AnalyticsRange, required
    - `start` string, date, required: First day of the range, inclusive, in timezone
    - `end` string, date, required: Last day of the range, inclusive, in timezone
    - `days` integer, required
    - `timezone` string, required: IANA name of the timezone the days are counted in; UTC unless the request named one
  - `filters` AnalyticsFilters, required
    - `channel` string, nullable, required: The channel filter applied: direct | organic_search | paid_search | organic_social | paid_social | email | sms | affiliate | display | paid_other | referral | ai_assistant | other | shared_results; null for all
    - `device` string, nullable, required: The device filter applied: mobile | tablet | desktop; null for all
    - `new_returning` string, nullable, required: The visitor filter applied: new | returning; null for all
    - `country` string, nullable, required: The country filter applied, ISO 3166-1 alpha-2; null for all
  - `freshness` Freshness, required
    - `as_of` string, date-time, nullable, required: When the numbers for past hours were last brought up to date, UTC ISO 8601; today's visits and orders are always counted live; null before the first update
    - `next_refresh_at` string, date-time, nullable, required: When the next update is due, UTC ISO 8601; null when none is scheduled or the numbers are read live
    - `stale` boolean, required
    - `pending` boolean, required: True until every update behind these numbers has run once, so they may be incomplete
    - `closed_days_through` string, date, required: The last day whose numbers are settled: yesterday in the request's timezone
    - `today_live` boolean, required
  - `views` integer, required: Sessions that opened the quiz inside the range, plus the cohort itself.
  - `not_started` integer, required: views minus starts: sessions that viewed the quiz but had neither answered nor stepped forward by the end of the range.
  - `starts` integer, required: The cohort: sessions whose first interaction with the quiz (the first answer or the first step forward, whichever comes first) fell inside the range, each followed to its end. starts == completions + sum(sessions_dropped) + in_progress, where pages are served.
  - `completions` integer, required: Cohort sessions that finished the quiz, even past the range end.
  - `in_progress` integer, required: Cohort sessions that have neither completed nor ended yet.
  - `pages` FunnelPage[], nullable, required: Null on a plan that does not include the funnel by page: the counts are served, the pages are not.
    - `page_key` string, required
    - `title` string, required
    - `removed` boolean, required: True for a page the published version no longer has
    - `sessions_reached` integer, required: Sessions that opened this page at least once (one per person).
    - `sessions_reached_by_jump` integer, required: Sessions whose first arrival on this page was a jump rule.
    - `sessions_continued` integer, required: Sessions that moved on from this page: reached minus dropped minus those still on it.
    - `sessions_went_back` integer, required: Sessions that went back to the previous page from here. A Back or Skip pressed after a long idle, once the visit was already closed as timed out, is not recorded.
    - `sessions_skipped` integer, required: Sessions that used the skip button on this page. A Back or Skip pressed after a long idle, once the visit was already closed as timed out, is not recorded.
    - `sessions_dropped` integer, required: Sessions whose last page was this one and that ended without completing.
    - `dropped_share_of_starts` number, nullable, required: sessions_dropped as a percentage of the funnel's starts; null while nothing started.
    - `avg_time_on_page_ms` number, nullable, required: Average time on the page per visit, in milliseconds.

## Other responses

- `304`: If-None-Match matches the cached response; no body is sent.
- `401`: The key is missing, malformed, revoked or expired.
- `403`: The store's plan has no API access, or the key lacks the scope.
- `404`: Not found
- `422`: A request parameter is invalid.
- `429`: The key's or the store's bucket is full; Retry-After says when to try again.
- `503`: Request limits could not be checked for the body, or the store's details could not be read.
- `504`: The request timed out.

---

[API](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api.md) - [All operations](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api/revisions/dc2d1aa2b7c6?raw)