--- title: "Quiz answer conversion" method: GET path: "/v1/quizzes/{quiz_id}/analytics/answers" tags: ["analytics"] --- # Quiz answer conversion `GET /v1/quizzes/{quiz_id}/analytics/answers` ## Request - Base URL: `https://api.octaneai.com` - URL: `https://api.octaneai.com/v1/quizzes/{quiz_id}/analytics/answers` - Auth: HTTP bearer ## Path parameters - `quiz_id` string, required ## Query parameters - `component_key` string, nullable - `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. - AnalyticsAnswers - `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 - `currency` string, nullable, required: ISO 4217 code of the amounts: the one most linked orders carry, else the store's; null when neither is known - `questions` AnswersQuestion[], required - `page_key` string, required - `page_title` string, nullable, required - `component_key` string, required - `question` string, required - `kind` 'choice' | 'number', required: choice: answered by options | number: a slider or number input, answered in bands of values - `question` AnswersQuestion, required - `page_key` string, required - `page_title` string, nullable, required - `component_key` string, required - `question` string, required - `kind` 'choice' | 'number', required: choice: answered by options | number: a slider or number input, answered in bands of values - `answered` integer, required: Visits that answered the question in the range - `options` AnswerOptionRow[], required: A choice question's rows, one per option; empty for a number question - `option_id` string, required - `label` string, required - `kind` 'choice' | 'image', required: choice | image (an image choice) - `image_url` string, nullable, required - `removed` boolean, required: True for an option that has answers but is gone from the published version; its id is its label - `chose` integer, required: Visits that picked this option; a multi-select visit counts under each option it picked - `chose_share` number, nullable, required: chose as a percentage of the visits that answered the question, 0 to 100; null when none did - `completed` integer, required: Of this row's visits, how many finished the quiz - `completion_rate` number, nullable, required: completed as a percentage of this row's visits, 0 to 100; null without visits - `opted_in` integer, required: Of this row's visits, how many submitted an email address or phone number - `opt_in_rate` number, nullable, required: opted_in as a percentage of this row's visits, 0 to 100; null without visits - `buyers` integer, required: Of this row's visits, how many were followed by a linked order, even after the range ended - `buyer_rate` number, nullable, required: buyers as a percentage of this row's visits, 0 to 100; null without visits - `answer_orders` integer, required: Linked orders that followed this row's visits; a visit with several answers brings its orders to each - `answer_revenue` Money, required - `amount` string, required: A decimal string, as "79.97" - `currency` string, required: ISO 4217 code - `buckets` AnswerBucketRow[], required: A number question's rows, one per band of values; empty for a choice question - `label` string, required - `low` number, required: The band's lowest value, included - `high` number, required: The band's highest value, excluded except on the last band; equal to low on a one-step band - `answered` integer, required: Visits whose answer fell in this band - `answered_share` number, nullable, required: answered as a percentage of the visits that answered the question, 0 to 100; null when none did - `completed` integer, required: Of this row's visits, how many finished the quiz - `completion_rate` number, nullable, required: completed as a percentage of this row's visits, 0 to 100; null without visits - `opted_in` integer, required: Of this row's visits, how many submitted an email address or phone number - `opt_in_rate` number, nullable, required: opted_in as a percentage of this row's visits, 0 to 100; null without visits - `buyers` integer, required: Of this row's visits, how many were followed by a linked order, even after the range ended - `buyer_rate` number, nullable, required: buyers as a percentage of this row's visits, 0 to 100; null without visits - `answer_orders` integer, required: Linked orders that followed this row's visits; a visit with several answers brings its orders to each - `answer_revenue` Money, required - `amount` string, required: A decimal string, as "79.97" - `currency` string, required: ISO 4217 code - `summary` AnswerNumericSummary, required - `count` integer, required - `min` number, required - `max` number, required - `mean` number, required - `median` number, 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. - `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)