---
title: "Suggestions"
method: GET
path: "/suggestions/{instancekey}"
tags: ["Suggestions"]
---

# Suggestions

`GET /suggestions/{instancekey}`

## Request

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

Service that returns search suggestions based on a search term. This service can be called as soon as the user begins to type a search term.

## Path parameters

- `instancekey` string, required

## Query parameters

- `tn_q` string, required
- `tn_cid` string, required
- `tn_lang` string
- `tn_use_filters` boolean
- `tn_parameters` string
- `tn_parameters_except` string
- `tn_keyboard` string

## Headers

- `TWN-Source` string

## Response `200`

Response with suggested searchterms

- SuggestionGroup[]
  - `name` string: Group title as configured in the corresponding algorithm
  - `type` string
  - `suggestions` Suggestion[]
    - `match` string: Suggestion match text
    - `navigationLink` SuggestionsNavigationLink
      - `path` string: The full navigation link path itself
      - `context` SuggestionsNavigationLinkContext
        - `searchterm` string: Searchterm used in the path
        - `category` SuggestionsNavigationLinkContextCategory
          - `path` string: The full path to the category
          - `name` string: The category name
          - `parentPath` string: The full path to the parent category
          - `parentName` string: The parent category name
          - `link` string: Link to the category
        - `facetFilters` SuggestionsNavigationLinkContextFacetFilter[]
          - `key` string: Key
          - `values` string[]
    - `redirects` Redirect[]
      - `url` string: Redirection URL

## 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)