Product Suggest API
Product suggest
POST
https://api-eu.attraqt.io/search/suggest
Search and group suggested products using the XO Search engine.
Request Body
Name | Type | Description |
---|---|---|
token | string | XO Search token (can be found in the XO Console) |
query | string | The query string used for the search |
options.sortBy | array | Sorting: \ Sort the results using the specified sort options. \ Defaults to an empty array (no sort applied, ie. results are sorted by relevancy). \ Check Sorting page for more info about the
array format. |
options.filter | string | Filtering: \ Filters the results based on the filter query (SQL-like syntax). \ Defaults to an empty array (no filter applied). \ Check Filtering page for more info about the
string format. |
options.customResponseMask | string | Attributes to retrieve: \ If specified, you have the control which attributes to retrieve and which not to retrieve. |
options.groupBy | object | Grouping: \ Group the results by specific values. \ Check Grouping page for more info about the format |
Example product suggest request
The following sample request includes all possible parameters you can use
Response
The product suggest response contains two parts:
Property | Type | Description |
---|---|---|
|
| Array of groups fetched from the catalog. Depends on the |
|
| Metadata about the search request: available facets, pagination, number of items, elapsed time, ... |
groups
groups
The groups matching the product suggest query.
Property | Type | Description |
---|---|---|
|
| Value on which this group was aggregated |
|
| Number of items included in this group. Note that only the first |
|
| List of items returned for this group. This array has the same format as the |
metadata
metadata
Metadata about the search query and its results.
Property | Type | Description |
---|---|---|
|
| Time the request took to complete (in milliseconds) |
|
| Search API token used for the request |
|
| Equivalent url that can be used to send the same request |
|
| Unique identifier |
|
| Search configuration id used |
Example
Last updated