Skip to content
Octane AI
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Welcome
Guides
Authentication
Connect an assistant
Rate limits
Errors
Pagination
Versioning
Quizzes and versions
Analytics
People
Exports
Webhooks
Storefront JS API
Developer section of the dashboard
Cookbook
Cookbook
Answer the quiz by voice
People who answered X but never bought
Put the quiz result on the order
A B2B quote from a quiz
Add a companion product with a quiz pick
Alert when completion drops
Confetti and a share card on finish
Send every finished quiz to your CRM
A daily digest of the whole store
Show the quiz discount as a QR code
Alert when a page loses shoppers after a publish
An editable kit with a live total
A filtered people file for your warehouse
A discount that grows as the shopper answers
Offer help when a shopper is stuck
Make the page react to the quiz
Auto-advance an in-store kiosk quiz
Open a fullscreen quiz after a delay or on exit intent
Pick the packing insert from the quiz result
A check-in quiz after the order
Prefill what the shopper already told you
Prefill one quiz from another
A printable routine card
Send quiz events to a tag manager
A 'your quiz picked this' marker on the product page
A discount on exactly the quiz's picks
Recommended products that are out of stock
Redirect after a quiz finishes
A subscription interval from the quiz's formula
A running match score while the shopper answers
Create a Shopify customer when a quiz finishes
Verify a webhook signature
A VIP file of top scorers who buy
A win-back list of the people who left at one page
API Reference
Overview
store
Overview
The store behind the key
quizzes
Overview
List quizzes
Get a quiz
Soft-delete a quiz
Archive a quiz
Unarchive a quiz
List saved versions
Save the draft as a version
Get a saved version summary
Publish a saved version
analytics
Overview
Store analytics by dimension
Store analytics overview
Compare quiz analytics
Store analytics summary
Quiz answer conversion
Quiz analytics by dimension
Quiz completion funnel
Quiz analytics overview
Quiz page-to-page journeys
Products attributed to a quiz
Quiz traffic sources
profiles
Overview
List or find shopper profiles
Find shopper profiles by what they answered
Get a shopper profile
exports
Overview
List exports
Request an export
Get an export and its download link
webhooks
Overview
List distinct events retained for webhook delivery
List webhook endpoints
Create a webhook endpoint
Get a webhook endpoint
Delete a webhook endpoint and its deliveries
Update webhook subscriptions or status
List deliveries and their stored payloads
Redeliver an event and replace its previous outcome
Redeliver failed events since a timestamp
Reveal the endpoint signing secret
Rotate the signing secret with 24-hour overlap
Queue a signed ping
Download the OpenAPI file
Select theme
Dark
Light
Auto
Overview
quizzes
Section titled “quizzes”
Quizzes and their versions: list, read, archive, delete, create and publish a version.
Operations
Section titled “Operations”
GET
/v1/quizzes
GET
/v1/quizzes/{quiz_id}
DELETE
/v1/quizzes/{quiz_id}
POST
/v1/quizzes/{quiz_id}/archive
POST
/v1/quizzes/{quiz_id}/unarchive
GET
/v1/quizzes/{quiz_id}/versions
POST
/v1/quizzes/{quiz_id}/versions
GET
/v1/quizzes/{quiz_id}/versions/{version_id}
POST
/v1/quizzes/{quiz_id}/versions/{version_id}/publish
