Quiz analytics overview
const url = 'https://api.octaneai.com/v1/quizzes/example/analytics/overview?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/overview?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
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
True when the first publish predates publish tracking and live_since is the oldest saved version’s time
Every publish of the quiz, oldest first
object
True when the publish predates publish tracking and its time is the oldest saved version’s
The publish’s day in the request’s timezone, the series day the marker sits on
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
Visits that finished the quiz: reached its last page and answered whatever that page requires
Visits where the shopper had declined tracking on the store
Visits where the shopper submitted an email address
Shopify orders linked to the quiz by its cart, the checkout or the email the shopper gave, by the day they were placed
Linked orders placed within the store’s order-matching window after the visit began; orders of items the quiz carted count up to 90 days
Visits where the shopper submitted a phone number
object
Visits where the shopper answered or stepped forward at least once
An estimate of how many different people opened the quiz; someone who came back counts once
Visits that opened the quiz on the store, whether or not the shopper answered anything; previews are not counted
object
Visits that finished the quiz: reached its last page and answered whatever that page requires
Visits where the shopper had declined tracking on the store
Visits where the shopper submitted an email address
Shopify orders linked to the quiz by its cart, the checkout or the email the shopper gave, by the day they were placed
Linked orders placed within the store’s order-matching window after the visit began; orders of items the quiz carted count up to 90 days
Visits where the shopper submitted a phone number
object
Visits where the shopper answered or stepped forward at least once
An estimate of how many different people opened the quiz; someone who came back counts once
Visits that opened the quiz on the store, whether or not the shopper answered anything; previews are not counted
Example
{ "data_start": "2026-09-01", "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 }, "live_since": "2026-09-01T00:00:00Z", "live_since_approximate": false, "markers": [ { "approximate": false, "day": "2026-09-03", "published_at": "2026-09-03T09:00:00Z", "version_number": 3 } ], "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7", "range": { "days": 7, "end": "2026-09-07", "start": "2026-09-01", "timezone": "UTC" }, "series": [ { "avg_time_to_complete_ms": 42000, "completions": 5, "consent_denied": 0, "day": "2026-09-01", "email_opt_ins": 2, "median_time_to_complete_ms": 40000, "orders": 1, "orders_inside_window": 1, "phone_opt_ins": 1, "revenue": { "amount": "12.50", "currency": "USD" }, "revenue_by_bucket": { "added_from_quiz": { "amount": "12.50", "currency": "USD" }, "bought_not_shown": { "amount": "0", "currency": "USD" }, "shown_bought_later": { "amount": "0", "currency": "USD" } }, "starts": 8, "unique_viewers_approx": 9, "views": 10 } ], "totals": { "aov": { "amount": "12.50", "currency": "USD" }, "avg_quiz_to_checkout_ms": 60000, "avg_time_to_complete_ms": 42000, "completion_rate": 62.5, "completions": 5, "consent_denied": 0, "email_opt_ins": 2, "median_quiz_to_checkout_ms": 60000, "median_time_to_complete_ms": 40000, "orders": 1, "orders_inside_window": 1, "phone_opt_ins": 1, "revenue": { "amount": "12.50", "currency": "USD" }, "revenue_by_bucket": { "added_from_quiz": { "amount": "12.50", "currency": "USD" }, "bought_not_shown": { "amount": "0", "currency": "USD" }, "shown_bought_later": { "amount": "0", "currency": "USD" } }, "start_rate": 80, "starts": 8, "unique_viewers_approx": 9, "views": 10 }}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"}