Quiz answer conversion
const url = 'https://api.octaneai.com/v1/quizzes/example/analytics/answers?tz=UTC';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.octaneai.com/v1/quizzes/example/analytics/answers?tz=UTC' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”Analytics for the range. ETag identifies the cached response.
object
Visits that answered the question in the range
A number question’s rows, one per band of values; empty for a choice question
object
Linked orders that followed this row’s visits; a visit with several answers brings its orders to each
Visits whose answer fell in this band
Of this row’s visits, how many were followed by a linked order, even after the range ended
Of this row’s visits, how many finished the quiz
The band’s highest value, excluded except on the last band; equal to low on a one-step band
The band’s lowest value, included
Of this row’s visits, how many submitted an email address or phone number
object
The last day whose numbers are settled: yesterday in the request’s timezone
True until every update behind these numbers has run once, so they may be incomplete
A choice question’s rows, one per option; empty for a number question
object
Linked orders that followed this row’s visits; a visit with several answers brings its orders to each
Of this row’s visits, how many were followed by a linked order, even after the range ended
Visits that picked this option; a multi-select visit counts under each option it picked
Of this row’s visits, how many finished the quiz
Choice | image (an image choice)
Of this row’s visits, how many submitted an email address or phone number
True for an option that has answers but is gone from the published version; its id is its label
object
Last day of the range, inclusive, in timezone
First day of the range, inclusive, in timezone
IANA name of the timezone the days are counted in; UTC unless the request named one
object
Example
{ "answered": 5, "buckets": [], "currency": "USD", "filters": {}, "freshness": { "as_of": "2026-09-07T12:00:00Z", "closed_days_through": "2026-09-06", "next_refresh_at": "2026-09-07T13:00:00Z", "pending": false, "stale": false, "today_live": true }, "options": [ { "answer_orders": 1, "answer_revenue": { "amount": "12.50", "currency": "USD" }, "buyer_rate": 50, "buyers": 1, "chose": 3, "chose_share": 60, "completed": 2, "completion_rate": 66.67, "image_url": "https://cdn.shopify.com/s/files/1/0001/skin-dry.jpg", "kind": "image", "label": "Dry", "opt_in_rate": 50, "opted_in": 1, "option_id": "opt-1", "removed": false } ], "question": { "component_key": "choice-abc12", "kind": "choice", "page_key": "skin", "page_title": "Skin", "question": "Skin type?" }, "questions": [ { "component_key": "choice-abc12", "kind": "choice", "page_key": "skin", "page_title": "Skin", "question": "Skin type?" } ], "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7", "range": { "days": 7, "end": "2026-09-07", "start": "2026-09-01", "timezone": "UTC" }}Headers
Section titled “Headers”Example
"5a23d8"If-None-Match matches the cached response; no body is sent.
Headers
Section titled “Headers”The key is missing, malformed, revoked or expired.
The body of every non-2xx response.
object
What went wrong, for people
object
The input that failed, as a dotted path (body.label, query.from)
Why it failed
The same value as the Request-Id header; quote it to support
The HTTP status of the response
The machine-readable error code; the Errors guide lists every one
A stable URI naming the error, on this API’s public host
Example
{ "detail": "The API key is missing, malformed, revoked or expired", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "status": 401, "title": "invalid_api_key", "type": "https://api.octaneai.com/errors/invalid_api_key"}Headers
Section titled “Headers”Example
BearerThe store’s plan has no API access, or the key lacks the scope.
The body of every non-2xx response.
object
What went wrong, for people
object
The input that failed, as a dotted path (body.label, query.from)
Why it failed
The same value as the Request-Id header; quote it to support
The HTTP status of the response
The machine-readable error code; the Errors guide lists every one
A stable URI naming the error, on this API’s public host
Examples
{ "detail": "The API key does not carry the scope this route needs", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "required": [ "analytics:read" ], "status": 403, "title": "insufficient_scope", "type": "https://api.octaneai.com/errors/insufficient_scope"}{ "detail": "The merchant API is available on the Plus and Enterprise plans", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "status": 403, "title": "plan_required", "type": "https://api.octaneai.com/errors/plan_required"}Not found
The body of every non-2xx response.
object
What went wrong, for people
object
The input that failed, as a dotted path (body.label, query.from)
Why it failed
The same value as the Request-Id header; quote it to support
The HTTP status of the response
The machine-readable error code; the Errors guide lists every one
A stable URI naming the error, on this API’s public host
Example
{ "detail": "Not found", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "status": 404, "title": "not_found", "type": "https://api.octaneai.com/errors/not_found"}A request parameter is invalid.
The body of every non-2xx response.
object
What went wrong, for people
object
The input that failed, as a dotted path (body.label, query.from)
Why it failed
The same value as the Request-Id header; quote it to support
The HTTP status of the response
The machine-readable error code; the Errors guide lists every one
A stable URI naming the error, on this API’s public host
Example
{ "detail": "A request parameter is invalid.", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "status": 422, "title": "validation_error", "type": "https://api.octaneai.com/errors/validation_error"}The key’s or the store’s bucket is full; Retry-After says when to try again.
The body of every non-2xx response.
object
What went wrong, for people
object
The input that failed, as a dotted path (body.label, query.from)
Why it failed
The same value as the Request-Id header; quote it to support
The HTTP status of the response
The machine-readable error code; the Errors guide lists every one
A stable URI naming the error, on this API’s public host
Example
{ "detail": "Too many requests", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "retry_after": 1, "status": 429, "title": "rate_limited", "type": "https://api.octaneai.com/errors/rate_limited"}Request limits could not be checked for the body, or the store’s details could not be read.
The body of every non-2xx response.
object
What went wrong, for people
object
The input that failed, as a dotted path (body.label, query.from)
Why it failed
The same value as the Request-Id header; quote it to support
The HTTP status of the response
The machine-readable error code; the Errors guide lists every one
A stable URI naming the error, on this API’s public host
Examples
{ "detail": "A backing service is temporarily unavailable; retry shortly", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "retry_after": 2, "status": 503, "title": "dependency_unavailable", "type": "https://api.octaneai.com/errors/dependency_unavailable"}{ "detail": "Request limits cannot be checked right now; retry shortly", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "retry_after": 2, "status": 503, "title": "limiter_unavailable", "type": "https://api.octaneai.com/errors/limiter_unavailable"}The request timed out.
The body of every non-2xx response.
object
What went wrong, for people
object
The input that failed, as a dotted path (body.label, query.from)
Why it failed
The same value as the Request-Id header; quote it to support
The HTTP status of the response
The machine-readable error code; the Errors guide lists every one
A stable URI naming the error, on this API’s public host
Example
{ "detail": "The request timed out.", "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "status": 504, "title": "timeout", "type": "https://api.octaneai.com/errors/timeout"}