v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Results

Get results page config

Retrieve results page configuration

get/v1/quizzes/{id}/results_config

Path parameters

idstring required

The id of the quiz

Query parameters

keystring required

Index key for the customer's product catalog

sectionstring

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

quiz_version_idstring

Specific version id for the quiz.

Response

OK - Everything worked as expected.

results_configobject

Config for the results page

quiz_version_idstring

Version id of this quiz

quiz_idstring

id of quiz

metadataobject

Metadata for the quiz

Example response

{
  "results_config": {
    "desktop": {
      "title": {
        "text": "TITLE",
        "is_active": true
      },
      "description": {
        "text": "DESCRIPTION",
        "is_active": false
      },
      "response_summary": {
        "text": "SUMMARY",
        "is_active": true,
        "items_separator": ",",
        "last_separator": "AND"
      }
    }
  },
  "quiz_version_id": "11db5ac7-67e1-4000-9000-414d8425cab3",
  "quiz_id": "11db5ac7-67e1-4000-9000-414d8425cab3"
}