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

# Suggestions grouped

`GET /suggestions/grouped/{instancekey}`

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 containing links for grouped navigation

- 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.net/tweakwise/apis/frontend-api.md) · [All operations](https://skmtc.net/tweakwise/apis/frontend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tweakwise/frontend-api/revisions/9bd1e2b3633f/schema)