---
title: "Read quiz analytics by version"
method: GET
path: "/v1/quizzes/{quiz_id}/analytics/versions"
tags: ["analytics"]
---

# Read quiz analytics by version

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

## Request

- Base URL: `https://api.octaneai.com`
- URL: `https://api.octaneai.com/v1/quizzes/{quiz_id}/analytics/versions`
- 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

## Headers

- `if-none-match` string, nullable

## Response `200`

Version analytics with public version ids.

- AnalyticsVersions
  - `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
  - `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
  - `versions` AnalyticsVersion[], required: One row per version with activity in the range, newest first; activity of an unknown version last
    - `version_id` string, nullable, required
    - `version_number` integer, nullable, required: The version's number as the editor shows it (v14); null once the version is gone
    - `published_at` string, date-time, nullable, required: When the version was first published, UTC ISO 8601; null once the version is gone
    - `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
    - `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
  - `explainer_keys` string[], required: The camelCase names of the help topics that explain the numbers in this response

## Other responses

- `304`: The version analytics have not changed.
- `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)