Funnel

get

https://gateway.tweakwisenavigator.com/filterwizard/{instancekey}

Service that makes it possible to filter the products questioningly and only the products that meet the filter values will be shown. The result contains the questions with their answers and products which are the result of the selected answers. Additionally a navigation url is provided to go to a navigation page with selected filters for the funnel with selected answers.

Path Params

instancekey

string

required

Instance specific key.

Query Params

code

string

required

Funnel code.

catid

number

The category which must contain the results found.

Example: ?catid=100

answers

object

Answer(s) to questions formatted as key-value pairs.

The key of the question being answered has format qs{n}, where n is the ID of the question being answered.

The value contains the ID(s) of the answer(s) to the question. When multiple answers are provided, they should be separated by a comma (,).

Example: ?qs1=1%2C2&qs2=3

skip_qs

array of numbers

Collection of skipped questions.

Example: ?skip_qs=2%2C4%2C6 or ?skip_qs=2&skip_qs=4&skip_qs=6

skip_qs

take

number

Maximum desired amount of products.

skip

number

Amount of products to skip (useful for paging).

tn_use_filters

boolean

Whether or not navigation urls returned in the response use the tn_filters parameter (?tn_filters=brand%3DCoca%20Cola%26volume%3D1L, instead of ?tn_fk_brand=Coca%20Cola&tn_fk_volume=1L).

Example: ?tn_use_filters=true

Headers

TWN-Source

string

Defaults to Tweakwise API docs

The source of the request. See the article on the request source for more information.

Responses

401

Invalid instancekey supplied

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response with questions, their answers and resulting products of selected answers. Additionally a navigation url is provided to go to a navigation page with selected filters for the funnel with selected answers.