Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Quizzes

Retrieve quiz

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: quizzes(r).

Retrieve a quiz.

get/v1/quizzes/{quiz_id}

Path parameters

quiz_idstring required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products

Response

OK

display_namestring required

Name of the quiz to be displayed to end users

activeboolean

Identifies whether quiz should be displayed or not

idstring required

ID of the quiz.

logicobject

Logic that is used when going through quiz

created_atstring date-time required

Quiz creation date in ISO 8601 format

updated_atstring date-time required

Last quiz update date in ISO 8601 format.

metadata_jsonobject

Metadata related to the quiz and its questions.

pre_filter_expressionobject

Pre-filter expression to be applied to all questions.

Example response

{
  "display_name": "Product Finder Quiz",
  "active": true,
  "questions": [
    {
      "title": "What is your favorite color?",
      "description": "Choose your preferred color",
      "cta_text": "Next",
      "images": {
        "primary_url": "https://example.com/image.jpg",
        "primary_alt": "Product image",
        "secondary_url": "https://example.com/image2.jpg",
        "secondary_alt": "Alternative product view"
      },
      "internal_name": "q1_color",
      "bucket_id": 1,
      "options": [
        {
          "value": "Red",
          "attribute": {
            "color": "red"
          },
          "images": {
            "primary_url": "https://example.com/image.jpg",
            "primary_alt": "Product image",
            "secondary_url": "https://example.com/image2.jpg",
            "secondary_alt": "Alternative product view"
          }
        }
      ]
    }
  ]
}