Category tree

Service that provides a category tree.

Path Params
string
required

Instance specific key.

Query Params
number

The starting category for the resulting tree.

string

Hidden parameters can be added to the URL by using the parameter 'tn_parameters'.
The key is the facet URL-name. The value is the facet value that should be applied.

Important: double URL-encoding is required.

  1. Build the parameter string — combining keys and values:

    • encode special characters inside values (spaces, +, &, =, etc.)
    • concatenate multiple values using a pipe (|)
      example: brand=Coca%20Cola%7CPepsi&volume=1L%7C1.5L
  2. URL-encode the entire filter string — because the whole string is passed as a single query parameter value, encode it a second time:
    brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

  3. Append to the URL:
    ?tn_parameters=brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

string

Hidden exclusion parameters can be added to the URL by using the parameter 'tn_parameters_except'.
This is used to exclude certain parameters from the results (show everything except specified parameters).
The key is the facet URL-name. The value is the facet value that should be applied.

Important: double URL-encoding is required.

  1. Build the parameter string — combining keys and values:

    • encode special characters inside values (spaces, +, &, =, etc.)
    • concatenate multiple values using a pipe (|)
      example: brand=Coca%20Cola%7CPepsi&volume=1L%7C1.5L
  2. URL-encode the entire filter string — because the whole string is passed as a single query parameter value, encode it a second time:
    brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

  3. Append to the URL:
    ?tn_parameters_except=brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

Headers
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json