Grouping
Group results by values of a specified attribute
This feature is only available for the Product Suggest API
Parameters
The groupBy
parameter allows to group the results by values of any single-valued facetable attribute. Each value will return a group of items containing this value.
Name | Type | Is Required ? |
|
| ✅ |
groupBy
groupBy
Grouping options, must be a JSON object with the following properties:
Property | Type | Description |
---|---|---|
|
| Name of the attribute used for grouping |
| list of | List of values (of the attribute) to group by |
|
| Size of each group. Must be between 1 and 100 (inclusive) |
Notes
The maximum number of items returned is 100, no matter the
size
or number ofvalues
. For example, requesting 50values
withsize
5 will return only 2 items per group (and 50 groups)attribute
must be a single-valued facetable attribute. Lists and sets attributes can't be used for grouping
Response
All responses from XO Search uses the same format. Check API Reference page for a more detailed description of this format.
pageAPI ReferenceUsage example
Group results by 2 different
kind
:"box"
and"product"
NodeJS / NPM example
HTML example
Last updated