Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Results

Get results

Retrieve AI optimized quiz results for products (or optionally other sections).

get/v1/quizzes/{id}/results

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_session_idstring

Specific quiz session id for the quiz. Session id will be automatically assigned if it is not specified.

quiz_version_idstring

Specific version id for the quiz.

version_idstring

Specific version id for the quiz. Deprecated, please use quiz_version_id instead.

filters[<filter_name>]string

Any number of criteria by which you'd like to narrow the result set. This might be by color, size, or category (group) an item belongs to. Facets can be used as filters. Filters with the same key are 'OR'ed together, while filters with different keys are 'AND'ed together by default. If value has the form '<min>-<max>', it's interpreted as a range (e.g: 'filters[Price]=100-200' will match all items with 'Price' from '100' to '200').

num_results_per_pagestring

Specifies the number of results returned in each request. Defaults to 20 if not specified.

pagestring

Specifies the page number of the result to be fetched. Defaults to 1 if not specified.

astring[] required

A list of answers in the format ?a=<option_id>,<option_id>&a=<option_id> where multiple options for a single answer are supplied in the same answer parameter (separated by ",") and options for the next question are supplied in the next answer parameter.

Response

OK - Everything worked as expected.

filter_expressionobject nullable

Resulting filter expression generated from the various attributes selected after answering a quiz.

resultsobject[] nullable

Final results

Example response

{
  "filter_expression": {
    "or": [
      {
        "and": [
          {
            "name": "TEST_FILTER_NAME",
            "value": "TEST_FILTER_VALUE"
          },
          {
            "not": {
              "name": "TEST_FILTER_NAME_2",
              "value": "TEST_FILTER_VALUE_2"
            }
          }
        ]
      },
      {
        "name": "TEST_FILTER_NAME_3",
        "value": "TEST_FILTER_VALUE_3"
      }
    ]
  }
}