---
title: "Compare quiz analytics"
method: GET
path: "/v1/analytics/quizzes"
tags: ["analytics"]
---

# Compare quiz analytics

`GET /v1/analytics/quizzes`

## Request

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

## Query parameters

- `q` string, nullable
- `limit` integer
- `offset` integer
- `sort` 'name' | 'views' | 'starts' | 'completion_rate' | 'opt_ins' | 'orders' | 'revenue' | 'share'
- `dir` 'asc' | 'desc'
- `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

## Headers

- `if-none-match` string, nullable

## Response `200`

Analytics for the range. ETag identifies the cached response.

- AnalyticsQuizzes
  - `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
  - `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
  - `data` QuizRow[], required
    - `quiz_id` string, required
    - `name` string, required
    - `status` 'draft' | 'published' | 'deleted', required: Publish-lifecycle status for an app. DRAFT: editable; not served to the storefront embed. PUBLISHED: a version is live; the embed serves the published snapshot. DELETED: soft-deleted; hidden from the dashboard list and the embed, but the row (pages, versions) is retained for recoverability. The column is a plain VARCHAR (native_enum=False), so this value needs no migration.
    - `views` integer, required: Visits that opened the quiz on the store, whether or not the shopper answered anything; previews are not counted
    - `starts` integer, required: Visits where the shopper answered or stepped forward at least once
    - `completions` integer, required: Visits that finished the quiz: reached its last page and answered whatever that page requires
    - `completion_rate` number, nullable, required: Completions as a percentage of starts, 0 to 100; null without starts
    - `email_opt_ins` integer, required: Visits where the shopper submitted an email address
    - `phone_opt_ins` integer, required: Visits where the shopper submitted a phone number
    - `orders` integer, required: Shopify orders linked to the quiz by its cart, the checkout or the email the shopper gave, by the day they were placed
    - `revenue` Money, required
      - `amount` string, required: A decimal string, as "79.97"
      - `currency` string, required: ISO 4217 code
    - `attributed_share` number, nullable, required: This quiz's revenue as a percentage of all quiz-linked revenue in the store for the range, 0 to 100; null when there is none
    - `avg_time_to_complete_ms` number, nullable, required: Average milliseconds from the first answer to finishing, over visits that finished on a later page than their first answer; null without one
    - `median_time_to_complete_ms` number, nullable, required: Median milliseconds from the first answer to finishing, an estimate over visits that finished on a later page than their first answer; null without one
  - `has_more` boolean, required
  - `total` integer, required: How many quizzes match the search, across every page
  - `limit` integer, required
  - `offset` integer, required
  - `sort` 'name' | 'views' | 'starts' | 'completion_rate' | 'opt_ins' | 'orders' | 'revenue' | 'share', required
  - `dir` 'asc' | 'desc', required

## 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.
- `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)