Search

Operations for search and suggest

Category ASN for Navigation

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Query parameters

cacheIrrelevantstring[]Optional

Flag parameters as cache irrelevant

endLevelinteger · int32Optional

Category end level

excludeProductsNotInRangebooleanOptional

Use this parameter to override the geo setting "exclude products not in range" for this request.

filterstring[]Optional

Filter for the whole field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

latitudenumber · double · min: -90 · max: 90Optional

The latitude coordinate of the location.

longitudenumber · double · min: -180 · max: 180Optional

The longitude coordinate of the location.

marketIdstring[]Optional

Only show products that have values for these market IDs.

maxDistancenumber · double · min: 1Optional

Use this parameter to override the geo setting "maximum distance" for this request.

purchaserIdstring · min: 1 · max: 2147483647Optional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

showMarketsbooleanOptional

Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.

showPermutedSearchParamsbooleanOptional

Specifies whether to include search parameters in the response for facet and sort item elements. The flag is enabled by default.

Example: true

sidstringOptional

The session id

splitDocumentsAtinteger · int32Optional

Threshold for variant splitting of documents.

startLevelinteger · int32Optional

Category start level

substringFilterstring[]Optional

Filter for a sub string of the field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

useAbTestbooleanOptional

If true, AbTest features will be active.

Example: true

useCachebooleanOptional

If true, the search result will be returned from cache memory, if a possible matching result exists.

Example: true

useGeobooleanOptional

If true, geoSearch features will be active.

Example: true

userIdstringOptional

The user id

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/navigation/category/{channel} HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "facets": [
    {
      "associatedFieldName": "text",
      "decimalPlaces": 2,
      "detailedLinks": 1,
      "elements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "filterStyle": "DEFAULT",
      "name": "text",
      "selectedElements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "selectionType": "singleHideUnselected",
      "showPreviewImages": true,
      "type": "FLOAT",
      "unit": "cm"
    }
  ],
  "timedOut": true
}

Navigation

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Query parameters

advisorStatusstring · min: 1 · max: 2147483647Optional

For specifying the current campaign id and answer path; format: campaignId-answerPath; example = '4-_0_1'

cacheIrrelevantstring[]Optional

Flag parameters as cache irrelevant

deduplicationFieldstringOptional

Specifies on which field variants should be deduplicated.

excludeProductsNotInRangebooleanOptional

Use this parameter to override the geo setting "exclude products not in range" for this request.

filterstring[]Optional

Filter for the whole field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

followSearchstringOptional

Optional request linking param from a previous search result or search param object. Can improve request performance.

hitsPerPageinteger · int32 · max: 100000Optional

In the FactFinder Management Interface you can define how many results will be returned on a page by default. If you prefer another number, you can set it with this parameter. Maximum of 100000 hits per page.

idsOnlybooleanOptional

If true, the returned records will contain only record IDs.

Example: false

latitudenumber · double · min: -90 · max: 90Optional

The latitude coordinate of the location.

longitudenumber · double · min: -180 · max: 180Optional

The longitude coordinate of the location.

marketIdstring[]Optional

Only show products that have values for these market IDs.

maxCountVariantsinteger · int32Optional

The maximum number of variants to return for every record

maxDistancenumber · double · min: 1Optional

Use this parameter to override the geo setting "maximum distance" for this request.

pageinteger · int32 · min: 1 · max: 1000000Optional

If a search result contains many results these will be divided into pages. This limits the amount of data that has to be sent in one go. You can indicate which page should be returned. Page numbering starts at 1 and ends at 1.000.000.

purchaserIdstring · min: 1 · max: 2147483647Optional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

showMarketsbooleanOptional

Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.

showPermutedSearchParamsbooleanOptional

Specifies whether to include search parameters in the response for facet and sort item elements. The flag is enabled by default.

Example: true

sidstringOptional

The session id

sortstring[]Optional

Sort the result; use FieldName Relevancy to sort the relevancy; format: FieldName:order order must be either asc or desc; example Manufacturer:asc

splitDocumentsAtinteger · int32Optional

Threshold for variant splitting of documents.

substringFilterstring[]Optional

Filter for a sub string of the field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

useAbTestbooleanOptional

If true, AbTest features will be active.

Example: true

useAsnbooleanOptional

If true, filters should be generated for the result.

Example: true

useAsobooleanOptional

If true, automatic search optimization will be used.

Example: true

useAtlasAibooleanOptional

If true, Atlas AI will be used.

Example: true

useCachebooleanOptional

If true, the search result will be returned from cache memory, if a possible matching result exists.

Example: true

useCampaignsbooleanOptional

If true, campaigns corresponding to this search result will be returned.

Example: true

useDeduplicationbooleanOptional

If true, the configured deduplication of variants will be used.

Example: true

useFoundWordsbooleanOptional

If true, the words that led to the records in the search results will be determined; this may require a large amount of processing time.

Example: false

useGeobooleanOptional

If true, geoSearch features will be active.

Example: true

usePersonalizationbooleanOptional

If true, the relevant products in the result will be personalized.

Example: true

useRankingbooleanOptional

If true, ranking will be applied.

Example: true

useSearchbooleanOptional

If true, search will be executed for the query.

Example: true

useSemanticEnhancerbooleanOptional

If true, the semantic enhancer will be used.

Example: true

useVectorSearchModestring · enumOptional

Specifies the integration of keyword search and vector search.

Example: FALLBACKPossible values:

userIdstringOptional

The user id

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/navigation/{channel} HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "answers": [
    {
      "id": "text",
      "questions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true,
      "text": "text"
    }
  ],
  "articleNumberSearch": true,
  "breadCrumbTrail": [
    {
      "associatedFieldName": "text",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "text": "text",
      "type": "search",
      "value": {}
    }
  ],
  "campaigns": [
    {
      "activeQuestions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "ad": true,
      "advisorTree": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "category": "text",
      "excludeProductsNotInMarkets": true,
      "excludeProductsNotInRange": true,
      "feedbackTexts": [
        {
          "html": true,
          "label": "product detail - below product",
          "position": 1,
          "teaser": true,
          "text": "text"
        }
      ],
      "flavour": "ADVISOR",
      "hits": [
        {
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "id": "text",
      "name": "text",
      "target": {
        "destination": "https://www.shop.de/about-us/contact.html",
        "name": "text"
      }
    }
  ],
  "exactSearchMode": "LEGACY",
  "facets": [
    {
      "associatedFieldName": "text",
      "decimalPlaces": 2,
      "detailedLinks": 1,
      "elements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "filterStyle": "DEFAULT",
      "name": "text",
      "selectedElements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "selectionType": "singleHideUnselected",
      "showPreviewImages": true,
      "type": "FLOAT",
      "unit": "cm"
    }
  ],
  "fieldRoles": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "filters": [
    {
      "filterWarning": "NON_EXISTING_FIELD",
      "name": "text",
      "substring": true,
      "values": [
        {
          "exclude": true,
          "type": "or",
          "value": "text"
        }
      ]
    }
  ],
  "followSearch": "text",
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  },
  "hits": [
    {
      "foundWords": [
        "text"
      ],
      "id": "text",
      "masterValues": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "position": 1,
      "score": 1,
      "variantValues": [
        {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "defaultHitsPerPage": 1,
    "hitsPerPage": 1,
    "nextLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    },
    "pageCount": 1,
    "previousLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    }
  },
  "resultType": "KEYWORD",
  "scoreFirstHit": 1,
  "scoreLastHit": 1,
  "searchControlParams": {
    "deduplicationField": "text",
    "idsOnly": true,
    "useAbTest": true,
    "useAsn": true,
    "useAso": true,
    "useAtlasAi": true,
    "useCache": true,
    "useCampaigns": true,
    "useDeduplication": true,
    "useFoundWords": true,
    "useGeo": true,
    "usePersonalization": true,
    "useRanking": true,
    "useSearch": true,
    "useSemanticEnhancer": true,
    "useVectorSearchMode": "DISABLED"
  },
  "searchParams": {
    "activeAbTests": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "advisorStatus": {
      "answerPath": "_0_0_0_1",
      "id": "text"
    },
    "articleNumberSearch": "DETECT",
    "customParameters": [
      {
        "cacheIrrelevant": true,
        "name": "text",
        "values": [
          "text"
        ]
      }
    ],
    "exactSearchMode": "LEGACY",
    "excludeProductsNotInRange": true,
    "filters": [
      {
        "filterWarning": "NON_EXISTING_FIELD",
        "name": "text",
        "substring": true,
        "values": [
          {
            "exclude": true,
            "type": "or",
            "value": "text"
          }
        ]
      }
    ],
    "followSearch": "text",
    "hitsPerPage": 1,
    "location": {
      "latitude": 1,
      "longitude": 1
    },
    "marketIds": [
      "text"
    ],
    "maxCountVariants": 1,
    "maxDistance": 1,
    "page": 1,
    "purchaserId": "text",
    "query": "text",
    "searchField": "text",
    "showMarkets": true,
    "showPermutedSearchParams": true,
    "sortItems": [
      {
        "name": "text",
        "order": "asc"
      }
    ],
    "splitDocumentsAt": 1
  },
  "singleWordResults": [
    {
      "previewRecords": [
        {
          "foundWords": [
            "text"
          ],
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "position": 1,
          "score": 1,
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "totalHits": 1,
      "word": "text"
    }
  ],
  "sortItems": [
    {
      "description": "text",
      "name": "text",
      "order": "asc",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true
    }
  ],
  "splitDocuments": true,
  "timedOut": true,
  "tookAtlasAi": 1,
  "tookGPTSynonyms": 1,
  "tookLoop54": 1,
  "tookTotal": 1,
  "tookVector": 1,
  "tookWorldmatch": 1,
  "totalHits": 1
}

Navigation with POST

post

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Body

sidstringOptional

The session ID of the user sending this search request.

userIdstringOptional

The user ID of the user sending this search request.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /fact-finder//rest/v5/navigation/{channel} HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1022

{
  "params": {
    "activeAbTests": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "advisorStatus": {
      "answerPath": "_0_0_0_1",
      "id": "text"
    },
    "customParameters": [
      {
        "cacheIrrelevant": true,
        "name": "text",
        "values": [
          "text"
        ]
      }
    ],
    "excludeProductsNotInRange": true,
    "filters": [
      {
        "filterWarning": "NON_EXISTING_FIELD",
        "name": "text",
        "substring": true,
        "values": [
          {
            "exclude": true,
            "type": "or",
            "value": "text"
          }
        ]
      }
    ],
    "followSearch": "text",
    "hitsPerPage": 1,
    "location": {
      "latitude": 1,
      "longitude": 1
    },
    "marketIds": [
      "text"
    ],
    "maxCountVariants": 1,
    "maxDistance": 1,
    "page": 1,
    "purchaserId": "text",
    "showMarkets": true,
    "showPermutedSearchParams": true,
    "sortItems": [
      {
        "name": "text",
        "order": "asc"
      }
    ],
    "splitDocumentsAt": 1
  },
  "searchControlParams": {
    "deduplicationField": "text",
    "idsOnly": true,
    "useAbTest": true,
    "useAsn": true,
    "useAso": true,
    "useAtlasAi": true,
    "useCache": true,
    "useCampaigns": true,
    "useDeduplication": true,
    "useFoundWords": true,
    "useGeo": true,
    "usePersonalization": true,
    "useRanking": true,
    "useSearch": true,
    "useSemanticEnhancer": true,
    "useVectorSearchMode": "DISABLED"
  },
  "sid": "text",
  "userId": "text"
}

{
  "answers": [
    {
      "id": "text",
      "questions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true,
      "text": "text"
    }
  ],
  "articleNumberSearch": true,
  "breadCrumbTrail": [
    {
      "associatedFieldName": "text",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "text": "text",
      "type": "search",
      "value": {}
    }
  ],
  "campaigns": [
    {
      "activeQuestions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "ad": true,
      "advisorTree": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "category": "text",
      "excludeProductsNotInMarkets": true,
      "excludeProductsNotInRange": true,
      "feedbackTexts": [
        {
          "html": true,
          "label": "product detail - below product",
          "position": 1,
          "teaser": true,
          "text": "text"
        }
      ],
      "flavour": "ADVISOR",
      "hits": [
        {
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "id": "text",
      "name": "text",
      "target": {
        "destination": "https://www.shop.de/about-us/contact.html",
        "name": "text"
      }
    }
  ],
  "exactSearchMode": "LEGACY",
  "facets": [
    {
      "associatedFieldName": "text",
      "decimalPlaces": 2,
      "detailedLinks": 1,
      "elements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "filterStyle": "DEFAULT",
      "name": "text",
      "selectedElements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "selectionType": "singleHideUnselected",
      "showPreviewImages": true,
      "type": "FLOAT",
      "unit": "cm"
    }
  ],
  "fieldRoles": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "filters": [
    {
      "filterWarning": "NON_EXISTING_FIELD",
      "name": "text",
      "substring": true,
      "values": [
        {
          "exclude": true,
          "type": "or",
          "value": "text"
        }
      ]
    }
  ],
  "followSearch": "text",
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  },
  "hits": [
    {
      "foundWords": [
        "text"
      ],
      "id": "text",
      "masterValues": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "position": 1,
      "score": 1,
      "variantValues": [
        {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "defaultHitsPerPage": 1,
    "hitsPerPage": 1,
    "nextLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    },
    "pageCount": 1,
    "previousLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    }
  },
  "resultType": "KEYWORD",
  "scoreFirstHit": 1,
  "scoreLastHit": 1,
  "searchControlParams": {
    "deduplicationField": "text",
    "idsOnly": true,
    "useAbTest": true,
    "useAsn": true,
    "useAso": true,
    "useAtlasAi": true,
    "useCache": true,
    "useCampaigns": true,
    "useDeduplication": true,
    "useFoundWords": true,
    "useGeo": true,
    "usePersonalization": true,
    "useRanking": true,
    "useSearch": true,
    "useSemanticEnhancer": true,
    "useVectorSearchMode": "DISABLED"
  },
  "searchParams": {
    "activeAbTests": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "advisorStatus": {
      "answerPath": "_0_0_0_1",
      "id": "text"
    },
    "articleNumberSearch": "DETECT",
    "customParameters": [
      {
        "cacheIrrelevant": true,
        "name": "text",
        "values": [
          "text"
        ]
      }
    ],
    "exactSearchMode": "LEGACY",
    "excludeProductsNotInRange": true,
    "filters": [
      {
        "filterWarning": "NON_EXISTING_FIELD",
        "name": "text",
        "substring": true,
        "values": [
          {
            "exclude": true,
            "type": "or",
            "value": "text"
          }
        ]
      }
    ],
    "followSearch": "text",
    "hitsPerPage": 1,
    "location": {
      "latitude": 1,
      "longitude": 1
    },
    "marketIds": [
      "text"
    ],
    "maxCountVariants": 1,
    "maxDistance": 1,
    "page": 1,
    "purchaserId": "text",
    "query": "text",
    "searchField": "text",
    "showMarkets": true,
    "showPermutedSearchParams": true,
    "sortItems": [
      {
        "name": "text",
        "order": "asc"
      }
    ],
    "splitDocumentsAt": 1
  },
  "singleWordResults": [
    {
      "previewRecords": [
        {
          "foundWords": [
            "text"
          ],
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "position": 1,
          "score": 1,
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "totalHits": 1,
      "word": "text"
    }
  ],
  "sortItems": [
    {
      "description": "text",
      "name": "text",
      "order": "asc",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true
    }
  ],
  "splitDocuments": true,
  "timedOut": true,
  "tookAtlasAi": 1,
  "tookGPTSynonyms": 1,
  "tookLoop54": 1,
  "tookTotal": 1,
  "tookVector": 1,
  "tookWorldmatch": 1,
  "totalHits": 1
}

Search

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Query parameters

advisorStatusstring · min: 1 · max: 2147483647Optional

For specifying the current campaign id and answer path; format: campaignId-answerPath; example = '4-_0_1'

articleNumberSearchstring · enumOptional

Specifies if the query should be interpreted as article number

Example: DETECTPossible values:

cacheIrrelevantstring[]Optional

Flag parameters as cache irrelevant

deduplicationFieldstringOptional

Specifies on which field variants should be deduplicated.

exactSearchModestring · enumOptional

Specifies if (and how) the query should be used for exact-value look-ups.

Possible values:

excludeProductsNotInRangebooleanOptional

Use this parameter to override the geo setting "exclude products not in range" for this request.

filterstring[]Optional

Filter for the whole field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

followSearchstringOptional

Optional request linking param from a previous search result or search param object. Can improve request performance.

hitsPerPageinteger · int32 · max: 100000Optional

In the FactFinder Management Interface you can define how many results will be returned on a page by default. If you prefer another number, you can set it with this parameter. Maximum of 100000 hits per page.

idsOnlybooleanOptional

If true, the returned records will contain only record IDs.

Example: false

latitudenumber · double · min: -90 · max: 90Optional

The latitude coordinate of the location.

longitudenumber · double · min: -180 · max: 180Optional

The longitude coordinate of the location.

marketIdstring[]Optional

Only show products that have values for these market IDs.

maxCountVariantsinteger · int32Optional

The maximum number of variants to return for every record

maxDistancenumber · double · min: 1Optional

Use this parameter to override the geo setting "maximum distance" for this request.

pageinteger · int32 · min: 1 · max: 1000000Optional

If a search result contains many results these will be divided into pages. This limits the amount of data that has to be sent in one go. You can indicate which page should be returned. Page numbering starts at 1 and ends at 1.000.000.

purchaserIdstring · min: 1 · max: 2147483647Optional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

querystringRequired

The search term

queryFromSuggestbooleanOptional

This parameter indicates that the FactFinder query was triggered through a selection from the suggestion list.

searchFieldstringOptional

Normally FactFinder searches all fields defined as searchable. However it is possible to search only one specific field as well.

showMarketsbooleanOptional

Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.

showPermutedSearchParamsbooleanOptional

Specifies whether to include search parameters in the response for facet and sort item elements. The flag is enabled by default.

Example: true

sidstringOptional

The session id

sortstring[]Optional

Sort the result; use FieldName Relevancy to sort the relevancy; format: FieldName:order order must be either asc or desc; example Manufacturer:asc

splitDocumentsAtinteger · int32Optional

Threshold for variant splitting of documents.

substringFilterstring[]Optional

Filter for a sub string of the field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

useAbTestbooleanOptional

If true, AbTest features will be active.

Example: true

useAsnbooleanOptional

If true, filters should be generated for the result.

Example: true

useAsobooleanOptional

If true, automatic search optimization will be used.

Example: true

useAtlasAibooleanOptional

If true, Atlas AI will be used.

Example: true

useCachebooleanOptional

If true, the search result will be returned from cache memory, if a possible matching result exists.

Example: true

useCampaignsbooleanOptional

If true, campaigns corresponding to this search result will be returned.

Example: true

useDeduplicationbooleanOptional

If true, the configured deduplication of variants will be used.

Example: true

useFoundWordsbooleanOptional

If true, the words that led to the records in the search results will be determined; this may require a large amount of processing time.

Example: false

useGeobooleanOptional

If true, geoSearch features will be active.

Example: true

usePersonalizationbooleanOptional

If true, the relevant products in the result will be personalized.

Example: true

useRankingbooleanOptional

If true, ranking will be applied.

Example: true

useSearchbooleanOptional

If true, search will be executed for the query.

Example: true

useSemanticEnhancerbooleanOptional

If true, the semantic enhancer will be used.

Example: true

useVectorSearchModestring · enumOptional

Specifies the integration of keyword search and vector search.

Example: FALLBACKPossible values:

userIdstringOptional

The user id

userInputstringOptional

Use this parameter to send the characters, the shop user entered until the search query was triggered.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/search/{channel} HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "answers": [
    {
      "id": "text",
      "questions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true,
      "text": "text"
    }
  ],
  "articleNumberSearch": true,
  "breadCrumbTrail": [
    {
      "associatedFieldName": "text",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "text": "text",
      "type": "search",
      "value": {}
    }
  ],
  "campaigns": [
    {
      "activeQuestions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "ad": true,
      "advisorTree": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "category": "text",
      "excludeProductsNotInMarkets": true,
      "excludeProductsNotInRange": true,
      "feedbackTexts": [
        {
          "html": true,
          "label": "product detail - below product",
          "position": 1,
          "teaser": true,
          "text": "text"
        }
      ],
      "flavour": "ADVISOR",
      "hits": [
        {
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "id": "text",
      "name": "text",
      "target": {
        "destination": "https://www.shop.de/about-us/contact.html",
        "name": "text"
      }
    }
  ],
  "exactSearchMode": "LEGACY",
  "facets": [
    {
      "associatedFieldName": "text",
      "decimalPlaces": 2,
      "detailedLinks": 1,
      "elements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "filterStyle": "DEFAULT",
      "name": "text",
      "selectedElements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "selectionType": "singleHideUnselected",
      "showPreviewImages": true,
      "type": "FLOAT",
      "unit": "cm"
    }
  ],
  "fieldRoles": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "filters": [
    {
      "filterWarning": "NON_EXISTING_FIELD",
      "name": "text",
      "substring": true,
      "values": [
        {
          "exclude": true,
          "type": "or",
          "value": "text"
        }
      ]
    }
  ],
  "followSearch": "text",
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  },
  "hits": [
    {
      "foundWords": [
        "text"
      ],
      "id": "text",
      "masterValues": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "position": 1,
      "score": 1,
      "variantValues": [
        {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "defaultHitsPerPage": 1,
    "hitsPerPage": 1,
    "nextLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    },
    "pageCount": 1,
    "previousLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    }
  },
  "resultType": "KEYWORD",
  "scoreFirstHit": 1,
  "scoreLastHit": 1,
  "searchControlParams": {
    "deduplicationField": "text",
    "idsOnly": true,
    "useAbTest": true,
    "useAsn": true,
    "useAso": true,
    "useAtlasAi": true,
    "useCache": true,
    "useCampaigns": true,
    "useDeduplication": true,
    "useFoundWords": true,
    "useGeo": true,
    "usePersonalization": true,
    "useRanking": true,
    "useSearch": true,
    "useSemanticEnhancer": true,
    "useVectorSearchMode": "DISABLED"
  },
  "searchParams": {
    "activeAbTests": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "advisorStatus": {
      "answerPath": "_0_0_0_1",
      "id": "text"
    },
    "articleNumberSearch": "DETECT",
    "customParameters": [
      {
        "cacheIrrelevant": true,
        "name": "text",
        "values": [
          "text"
        ]
      }
    ],
    "exactSearchMode": "LEGACY",
    "excludeProductsNotInRange": true,
    "filters": [
      {
        "filterWarning": "NON_EXISTING_FIELD",
        "name": "text",
        "substring": true,
        "values": [
          {
            "exclude": true,
            "type": "or",
            "value": "text"
          }
        ]
      }
    ],
    "followSearch": "text",
    "hitsPerPage": 1,
    "location": {
      "latitude": 1,
      "longitude": 1
    },
    "marketIds": [
      "text"
    ],
    "maxCountVariants": 1,
    "maxDistance": 1,
    "page": 1,
    "purchaserId": "text",
    "query": "text",
    "searchField": "text",
    "showMarkets": true,
    "showPermutedSearchParams": true,
    "sortItems": [
      {
        "name": "text",
        "order": "asc"
      }
    ],
    "splitDocumentsAt": 1
  },
  "singleWordResults": [
    {
      "previewRecords": [
        {
          "foundWords": [
            "text"
          ],
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "position": 1,
          "score": 1,
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "totalHits": 1,
      "word": "text"
    }
  ],
  "sortItems": [
    {
      "description": "text",
      "name": "text",
      "order": "asc",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true
    }
  ],
  "splitDocuments": true,
  "timedOut": true,
  "tookAtlasAi": 1,
  "tookGPTSynonyms": 1,
  "tookLoop54": 1,
  "tookTotal": 1,
  "tookVector": 1,
  "tookWorldmatch": 1,
  "totalHits": 1
}

Search with POST

post

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Body

sidstringOptional

The session ID of the user sending this search request.

userIdstringOptional

The user ID of the user sending this search request.

userInputstringOptional

The search term entered by the user when a suggestion led to this search request.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /fact-finder//rest/v5/search/{channel} HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1135

{
  "params": {
    "activeAbTests": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "advisorStatus": {
      "answerPath": "_0_0_0_1",
      "id": "text"
    },
    "articleNumberSearch": "DETECT",
    "customParameters": [
      {
        "cacheIrrelevant": true,
        "name": "text",
        "values": [
          "text"
        ]
      }
    ],
    "exactSearchMode": "LEGACY",
    "excludeProductsNotInRange": true,
    "filters": [
      {
        "filterWarning": "NON_EXISTING_FIELD",
        "name": "text",
        "substring": true,
        "values": [
          {
            "exclude": true,
            "type": "or",
            "value": "text"
          }
        ]
      }
    ],
    "followSearch": "text",
    "hitsPerPage": 1,
    "location": {
      "latitude": 1,
      "longitude": 1
    },
    "marketIds": [
      "text"
    ],
    "maxCountVariants": 1,
    "maxDistance": 1,
    "page": 1,
    "purchaserId": "text",
    "query": "text",
    "searchField": "text",
    "showMarkets": true,
    "showPermutedSearchParams": true,
    "sortItems": [
      {
        "name": "text",
        "order": "asc"
      }
    ],
    "splitDocumentsAt": 1
  },
  "searchControlParams": {
    "deduplicationField": "text",
    "idsOnly": true,
    "useAbTest": true,
    "useAsn": true,
    "useAso": true,
    "useAtlasAi": true,
    "useCache": true,
    "useCampaigns": true,
    "useDeduplication": true,
    "useFoundWords": true,
    "useGeo": true,
    "usePersonalization": true,
    "useRanking": true,
    "useSearch": true,
    "useSemanticEnhancer": true,
    "useVectorSearchMode": "DISABLED"
  },
  "sid": "text",
  "userId": "text",
  "userInput": "text"
}

{
  "answers": [
    {
      "id": "text",
      "questions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true,
      "text": "text"
    }
  ],
  "articleNumberSearch": true,
  "breadCrumbTrail": [
    {
      "associatedFieldName": "text",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "text": "text",
      "type": "search",
      "value": {}
    }
  ],
  "campaigns": [
    {
      "activeQuestions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "ad": true,
      "advisorTree": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "category": "text",
      "excludeProductsNotInMarkets": true,
      "excludeProductsNotInRange": true,
      "feedbackTexts": [
        {
          "html": true,
          "label": "product detail - below product",
          "position": 1,
          "teaser": true,
          "text": "text"
        }
      ],
      "flavour": "ADVISOR",
      "hits": [
        {
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "id": "text",
      "name": "text",
      "target": {
        "destination": "https://www.shop.de/about-us/contact.html",
        "name": "text"
      }
    }
  ],
  "exactSearchMode": "LEGACY",
  "facets": [
    {
      "associatedFieldName": "text",
      "decimalPlaces": 2,
      "detailedLinks": 1,
      "elements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "filterStyle": "DEFAULT",
      "name": "text",
      "selectedElements": [
        {
          "absoluteMaxValue": 1,
          "absoluteMinValue": 1,
          "clusterLevel": 1,
          "distance": 1,
          "previewImageURL": "text",
          "searchParams": {
            "activeAbTests": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "advisorStatus": {
              "answerPath": "_0_0_0_1",
              "id": "text"
            },
            "articleNumberSearch": "DETECT",
            "customParameters": [
              {
                "cacheIrrelevant": true,
                "name": "text",
                "values": [
                  "text"
                ]
              }
            ],
            "exactSearchMode": "LEGACY",
            "excludeProductsNotInRange": true,
            "filters": [
              {
                "filterWarning": "NON_EXISTING_FIELD",
                "name": "text",
                "substring": true,
                "values": [
                  {
                    "exclude": true,
                    "type": "or",
                    "value": "text"
                  }
                ]
              }
            ],
            "followSearch": "text",
            "hitsPerPage": 1,
            "location": {
              "latitude": 1,
              "longitude": 1
            },
            "marketIds": [
              "text"
            ],
            "maxCountVariants": 1,
            "maxDistance": 1,
            "page": 1,
            "purchaserId": "text",
            "query": "text",
            "searchField": "text",
            "showMarkets": true,
            "showPermutedSearchParams": true,
            "sortItems": [
              {
                "name": "text",
                "order": "asc"
              }
            ],
            "splitDocumentsAt": 1
          },
          "selected": "TRUE",
          "selectedMaxValue": 1,
          "selectedMinValue": 1,
          "showDistance": true,
          "text": "text",
          "totalHits": 1
        }
      ],
      "selectionType": "singleHideUnselected",
      "showPreviewImages": true,
      "type": "FLOAT",
      "unit": "cm"
    }
  ],
  "fieldRoles": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "filters": [
    {
      "filterWarning": "NON_EXISTING_FIELD",
      "name": "text",
      "substring": true,
      "values": [
        {
          "exclude": true,
          "type": "or",
          "value": "text"
        }
      ]
    }
  ],
  "followSearch": "text",
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  },
  "hits": [
    {
      "foundWords": [
        "text"
      ],
      "id": "text",
      "masterValues": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "position": 1,
      "score": 1,
      "variantValues": [
        {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "defaultHitsPerPage": 1,
    "hitsPerPage": 1,
    "nextLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    },
    "pageCount": 1,
    "previousLink": {
      "currentPage": true,
      "number": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      }
    }
  },
  "resultType": "KEYWORD",
  "scoreFirstHit": 1,
  "scoreLastHit": 1,
  "searchControlParams": {
    "deduplicationField": "text",
    "idsOnly": true,
    "useAbTest": true,
    "useAsn": true,
    "useAso": true,
    "useAtlasAi": true,
    "useCache": true,
    "useCampaigns": true,
    "useDeduplication": true,
    "useFoundWords": true,
    "useGeo": true,
    "usePersonalization": true,
    "useRanking": true,
    "useSearch": true,
    "useSemanticEnhancer": true,
    "useVectorSearchMode": "DISABLED"
  },
  "searchParams": {
    "activeAbTests": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "advisorStatus": {
      "answerPath": "_0_0_0_1",
      "id": "text"
    },
    "articleNumberSearch": "DETECT",
    "customParameters": [
      {
        "cacheIrrelevant": true,
        "name": "text",
        "values": [
          "text"
        ]
      }
    ],
    "exactSearchMode": "LEGACY",
    "excludeProductsNotInRange": true,
    "filters": [
      {
        "filterWarning": "NON_EXISTING_FIELD",
        "name": "text",
        "substring": true,
        "values": [
          {
            "exclude": true,
            "type": "or",
            "value": "text"
          }
        ]
      }
    ],
    "followSearch": "text",
    "hitsPerPage": 1,
    "location": {
      "latitude": 1,
      "longitude": 1
    },
    "marketIds": [
      "text"
    ],
    "maxCountVariants": 1,
    "maxDistance": 1,
    "page": 1,
    "purchaserId": "text",
    "query": "text",
    "searchField": "text",
    "showMarkets": true,
    "showPermutedSearchParams": true,
    "sortItems": [
      {
        "name": "text",
        "order": "asc"
      }
    ],
    "splitDocumentsAt": 1
  },
  "singleWordResults": [
    {
      "previewRecords": [
        {
          "foundWords": [
            "text"
          ],
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "position": 1,
          "score": 1,
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "totalHits": 1,
      "word": "text"
    }
  ],
  "sortItems": [
    {
      "description": "text",
      "name": "text",
      "order": "asc",
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "selected": true
    }
  ],
  "splitDocuments": true,
  "timedOut": true,
  "tookAtlasAi": 1,
  "tookGPTSynonyms": 1,
  "tookLoop54": 1,
  "tookTotal": 1,
  "tookVector": 1,
  "tookWorldmatch": 1,
  "totalHits": 1
}

Get suggestions

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Query parameters

advisorStatusstring · min: 1 · max: 2147483647Optional

For specifying the current campaign id and answer path; format: campaignId-answerPath; example = '4-_0_1'

articleNumberSearchstring · enumOptional

Specifies if the query should be interpreted as article number

Example: DETECTPossible values:

cacheIrrelevantstring[]Optional

Flag parameters as cache irrelevant

exactSearchModestring · enumOptional

Specifies if (and how) the query should be used for exact-value look-ups.

Possible values:

excludeProductsNotInRangebooleanOptional

Use this parameter to override the geo setting "exclude products not in range" for this request.

filterstring[]Optional

Filter for the whole field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

followSearchstringOptional

Optional request linking param from a previous search result or search param object. Can improve request performance.

hitsPerPageinteger · int32 · max: 100000Optional

In the FactFinder Management Interface you can define how many results will be returned on a page by default. If you prefer another number, you can set it with this parameter. Maximum of 100000 hits per page.

includeMarketIdsForNonResultFieldsbooleanOptional

Controls whether markets should be returned, even if no geo fields are configured as return attributes.

latitudenumber · double · min: -90 · max: 90Optional

The latitude coordinate of the location.

longitudenumber · double · min: -180 · max: 180Optional

The longitude coordinate of the location.

marketIdstring[]Optional

Only show products that have values for these market IDs.

maxCountVariantsinteger · int32Optional

The maximum number of variants to return for every record

maxDistancenumber · double · min: 1Optional

Use this parameter to override the geo setting "maximum distance" for this request.

pageinteger · int32 · min: 1 · max: 1000000Optional

If a search result contains many results these will be divided into pages. This limits the amount of data that has to be sent in one go. You can indicate which page should be returned. Page numbering starts at 1 and ends at 1.000.000.

purchaserIdstring · min: 1 · max: 2147483647Optional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

querystringRequired

The search term

searchFieldstringOptional

Normally FactFinder searches all fields defined as searchable. However it is possible to search only one specific field as well.

showMarketsbooleanOptional

Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.

showPermutedSearchParamsbooleanOptional

Specifies whether to include search parameters in the response for facet and sort item elements. The flag is enabled by default.

Example: true

sidstringOptional

the session id from the user

sortstring[]Optional

Sort the result; use FieldName Relevancy to sort the relevancy; format: FieldName:order order must be either asc or desc; example Manufacturer:asc

splitDocumentsAtinteger · int32Optional

Threshold for variant splitting of documents.

substringFilterstring[]Optional

Filter for a sub string of the field value; a filter can have multiple values, the values can be separated with the following characters (they are configurable in the config.xml) 'and' = ___ 'or' = ~~~ the filter value can be excluded with the prefix ! format: facetid:value; example Red~~~!Green = red or not green. If the filter name equals '*', the filter will be applied on any field; example: *:Red~~~Green. This filter type does not support the exclusion prefix. Be aware that filter values for category path filters have to be URL encoded, so a '100%' category path filter value would be '100%25'. It will be encoded a second time when used via 'GET', Swagger will do this second encoding automatically, so the URL contains '100%2525'. Numeric filters use standard mathematical interval notation, but only intervals that are closed on the left and open on the right are allowed inputs. So only intervals of the form [a,b), [a,) or [a,] are allowed. Square brackets mean that the value is included and round brackets mean that the value is not included. E.g. if you want to cover the range 20.00-49.99 please insert [20.00,50.00).

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/suggest/{channel} HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "articleNumberSearchAllowed": true,
  "fieldRoles": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  },
  "splitDocuments": true,
  "suggestions": [
    {
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "hitCount": 1,
      "image": "text",
      "name": "text",
      "score": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "type": "brand"
    }
  ]
}

Get suggestions with POST

post

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Body

articleNumberSearchstring · enumOptional

Specifies if the search term should be interpreted as article number. Defaults to DETECT.

Possible values:

exactSearchModestring · enumOptional

Specifies whether the search term should be considered for the exact search, and how. Defaults to the mode that is configured for the channel.

Possible values:

excludeProductsNotInRangebooleanOptional

Overrides the excludeProductsNotInRange setting for the geo search.

followSearchstringOptional

Optional request linking param from a previous search result or search param object. Can improve request performance.

hitsPerPageinteger · int32Optional

Number of products on a single page.

includeMarketIdsForNonResultFieldsbooleanOptional

Controls whether markets should be returned, even if no geo fields are configured as return attributes.

marketIdsstring[]Optional

Only show products that have values for these market IDs.

maxCountVariantsinteger · int32Optional

Defines the maximum number of variants to be returned in the result.

maxDistancenumber · double · min: 1Optional

Overrides the maximum distance setting for the geo search.

pageinteger · int32 · min: 1Optional

The page to be requested within the search result.

purchaserIdstring · min: 1 · max: 2147483647Optional

The ID of the purchaser. This ID is only needed if the 'Customer-Specific Info' module is activated. Otherwise it will be ignored.

querystringRequired

The search term.

searchFieldstringOptional

If set, the search term will be looked for only in the given field. Otherwise all searchable fields will be considered (for article number searches, all fields marked as containing article numbers).

showMarketsbooleanOptional

Overrides the showMarkets setting for the geo search.

showPermutedSearchParamsbooleanOptional

Specifies whether to include search parameters in the response for facet and sort item elements.

sidstringOptional

The session id. Required for A/B testing.

splitDocumentsAtinteger · int32Optional

Threshold for variant splitting of documents.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /fact-finder//rest/v5/suggest/{channel} HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 785

{
  "activeAbTests": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "advisorStatus": {
    "answerPath": "_0_0_0_1",
    "id": "text"
  },
  "articleNumberSearch": "DETECT",
  "customParameters": [
    {
      "cacheIrrelevant": true,
      "name": "text",
      "values": [
        "text"
      ]
    }
  ],
  "exactSearchMode": "LEGACY",
  "excludeProductsNotInRange": true,
  "filters": [
    {
      "filterWarning": "NON_EXISTING_FIELD",
      "name": "text",
      "substring": true,
      "values": [
        {
          "exclude": true,
          "type": "or",
          "value": "text"
        }
      ]
    }
  ],
  "followSearch": "text",
  "hitsPerPage": 1,
  "includeMarketIdsForNonResultFields": true,
  "location": {
    "latitude": 1,
    "longitude": 1
  },
  "marketIds": [
    "text"
  ],
  "maxCountVariants": 1,
  "maxDistance": 1,
  "page": 1,
  "purchaserId": "text",
  "query": "text",
  "searchField": "text",
  "showMarkets": true,
  "showPermutedSearchParams": true,
  "sid": "text",
  "sortItems": [
    {
      "name": "text",
      "order": "asc"
    }
  ],
  "splitDocumentsAt": 1
}

{
  "articleNumberSearchAllowed": true,
  "fieldRoles": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  },
  "splitDocuments": true,
  "suggestions": [
    {
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "hitCount": 1,
      "image": "text",
      "name": "text",
      "score": 1,
      "searchParams": {
        "activeAbTests": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "advisorStatus": {
          "answerPath": "_0_0_0_1",
          "id": "text"
        },
        "articleNumberSearch": "DETECT",
        "customParameters": [
          {
            "cacheIrrelevant": true,
            "name": "text",
            "values": [
              "text"
            ]
          }
        ],
        "exactSearchMode": "LEGACY",
        "excludeProductsNotInRange": true,
        "filters": [
          {
            "filterWarning": "NON_EXISTING_FIELD",
            "name": "text",
            "substring": true,
            "values": [
              {
                "exclude": true,
                "type": "or",
                "value": "text"
              }
            ]
          }
        ],
        "followSearch": "text",
        "hitsPerPage": 1,
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "marketIds": [
          "text"
        ],
        "maxCountVariants": 1,
        "maxDistance": 1,
        "page": 1,
        "purchaserId": "text",
        "query": "text",
        "searchField": "text",
        "showMarkets": true,
        "showPermutedSearchParams": true,
        "sortItems": [
          {
            "name": "text",
            "order": "asc"
          }
        ],
        "splitDocumentsAt": 1
      },
      "type": "brand"
    }
  ]
}

Get popular searches

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/suggest/{channel}/popularSearches HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "popularSearches": [
    {
      "name": "text",
      "type": "text"
    }
  ]
}