---
title: "Facets"
method: GET
path: "/facets/{instancekey}"
tags: ["Facets"]
---

# Facets

`GET /facets/{instancekey}`

## Request

- Base URL: `https://gateway.tweakwisenavigator.com`
- URL: `https://gateway.tweakwisenavigator.com/facets/{instancekey}`
- Auth: none declared

Service that returns only the facets and visible attributes for a request. This request is the same as the navigation request, but without the products. Only the visible facet attributes will be returned, based on nrofshownattributes.

## Path parameters

- `instancekey` string, required

## Query parameters

- `tn_q` string
- `tn_cid` string
- `tn_use_filters` boolean
- `tn_filters` string
- `tn_ft` number
- `tn_st` number
- `tn_b` number
- `tn_lang` string
- `tn_parameters` string
- `tn_parameters_except` string
- `tn_keyboard` string
- `tn_profilekey` string

## Headers

- `TWN-Source` string

## Response `200`

Response with the facets and visible attributes.

- FacetsResponse
  - `facets` NavigationFacet[]
    - `hasmoreattributes` boolean, nullable
    - `facetsettings` NavigationFacetSettings
      - `facetid` integer: Facet id
      - `isvisible` boolean: true/false to indicate if facet is visible
      - `attributename` string: Name of the attribute corresponding to the facet
      - `urlkey` string: URL Key of facet
      - `title` string: Title of facet
      - `iscollapsible` boolean: true/false to indicate if facet is collapsible
      - `iscollapsed` boolean: true/false to indicate if facet is collapsed
      - `nrofshownattributes` integer: Number of shown attributes
      - `expandtext` string: Text for the button or link that expands the facet
      - `collapsetext` string: Text for the button or link that collapses the facet
      - `ismultiselect` boolean: true/false to indicate if facet is multiselectable
      - `showselectedfirst` boolean: true/false to indicate if selected values are at the top of the facet
      - `multiselectlogic` string: Indicates whether conjunction logic (and) or disjunction logic (or) is used when selecting multiple values in a multiselect facet
      - `selectiontype` string: Type of selection for this facet. This could be checkbox, slider, tree or link
      - `nrofcolumns` integer: This field is deprecated and only in the response for backwards compatibility
      - `isnrofresultsvisible` boolean: true/false to indicate if number of resulting items is visible
      - `isinfovisible` boolean: true/false to indicate if info text should be displayed
      - `containsclickpoints` boolean: true/false to indicate if slider is type clickpoint
      - `containsbuckets` boolean: true/false to indicate if slider is type bucket
      - `infotext` string: Facet information text
      - `source` string: Source of the attribute corresponding to the facet
      - `issearchable` boolean: true/false to indicate if search is available within the facet
      - `searchplaceholder` string: Placeholder text for the facet search
      - `searchnoresultstext` string: Text for when there are no results for the facet search
      - `prefix` string: Attributes prefix
      - `postfix` string: Attributes postfix
      - `cssclass` string: Attributes css class
    - `attributes` NavigationFacetAttribute[]
      - `title` string: Title of the attribute
      - `alternatesortorder` integer, nullable: Alternate sort order
      - `isselected` boolean: true/false to indicate if attribute is selected
      - `nrofresults` integer: Resulting number of items when attribute is selected
      - `attributeid` integer, nullable: Attribute id
      - `url` string: Complete navigation url after selecting or deselecting value
      - `link` string: Optional landingpage url to which the user will navigate after selecting this value, this takes precedence over the url property
      - `imagetag` string: Tag of the image
      - `children` object[]: Recursive list of child attributes
    - `clickpoints` Clickpoint[]
      - `value` string: Value of clickpoint
    - `buckets` NavigationFacetBucket[]
      - `rangemin` number, double, nullable: Minimum size of bucket
      - `rangemax` number, double, nullable: Maximum size of bucket
      - `relativeamount` number, double, nullable: Relative size of bucket
  - `assistant` NavigationAssistant
    - `enabled` boolean
    - `reason` string

## Other responses

- `401`: Invalid instancekey supplied

---

[API](https://skmtc.dev/tweakwise/apis/delivery-api.md) - [All operations](https://skmtc.dev/tweakwise/apis/delivery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tweakwise/apis/delivery-api/revisions/8b9edcf45234?raw)