OCoctaneai
quizzes

Get a quiz

get/v1/quizzes/{quiz_id}

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Path parameters

quiz_idstring required

Response

The quiz summary and its structure: pages in order with their role, content components, rules and jumps, and the scoring dimensions. Never the quiz document; null and empty fields are left out.

idstring required
kind'quiz' | 'popup' required

What a stored app is: a quiz the store embeds, or a popup the store shows over its pages. One spelling everywhere: the phoenix.apps.kind column, the wire kind field, the TS mirror.

namestring 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.

archivedboolean required
published_versionstring nullable required

The version shoppers see; null when none is published

page_countinteger required

How many pages the quiz's draft has

created_atstring date-time required
updated_atstring date-time required
urlsobject required

self: this quiz on the API | versions: its versions on the API | dashboard: the quiz in the editor

Example response

{
  "id": "quiz_7c9e6679742540de944be07fc1f90ae7",
  "published_version": "ver_7c9e6679742540de944be07fc1f90ae7",
  "latest_version": {
    "id": "ver_7c9e6679742540de944be07fc1f90ae7",
    "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.