For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.

• Documentation >
• Search >
• Aggregation reference >
• Product attribute aggregations

Product attribute aggregations

Product attribute aggregations aggregate search results by the value of the product's attributes.

You use them over the REST API, in the Aggregations element of the payload of the POST /product/catalog/products/view request.

Depending on the attribute type, the following aggregations are available:

Name	Type	Based on attribute type
AttributeBooleanTerm	Term	Checkbox
AttributeColorTerm	Term	Color
AttributeFloatRange	Range	Float
AttributeFloatStats	Stats	Float
AttributeIntegerRange	Range	Integer
AttributeIntegerStats	Stats	Integer
AttributeSelectionTerm	Term	Selection

Arguments

• name - name of the Aggregation
• attributeDefinitionIdentifier - identifier of the attribute

Range aggregations (AttributeFloatRange and AttributeIntegerRange) additionally take:

• ranges - array of ranges that define the borders of the specific range sets

Example

"ProductQuery": {
    "Aggregations": [
        {
            "AttributeSelectionTerm": {
                "name": "size",
                "attributeDefinitionIdentifier": "size"
            }
        },
        {
            "AttributeIntegerRange": {
                "name": "length",
                "attributeDefinitionIdentifier": "length",
                "ranges": [
                    {
                        "from": null,
                        "to": 100
                    },
                    {
                        "from": 100,
                        "to": null
                    }
                ]
            }
        }
    ]
}

Copy as Markdown View as Markdown View on GitHub