get
https://{yourinstance}.makaira.io/search-term/check
Checks whether a search term is handled by any configured rule.
Checks whether a given search term is handled by any configured rule (synonym, antonym, search redirect, etc.) and returns the handlers that apply to it.
Request
GET /search-term/check
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
searchTerm | string | Yes | The search term to check. |
language | string | No | The shop language to check the term against (e.g. de, en). |
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Response
Returns a JSON object describing whether the search term is handled and which rules apply.
Response Body
| Field | Type | Description |
|---|---|---|
handled | boolean | true if at least one rule (synonym, antonym, redirect, etc.) applies to this search term. |
handlers | array | List of handlers that matched. Each handler has a type (string, e.g. synonym, antonym, searchredirect) and a data field with rule-specific details. |
Example Request
GET /search-term/check?searchTerm=jeans&language=deExample Response — term is handled
{
"handled": true,
"handlers": [
{
"type": "synonym",
"data": {
"id": 42,
"terms": ["jeans", "denim", "hose"]
}
}
]
}Example Response — term is not handled
{
"handled": false,
"handlers": []
}