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 >
• FloatStatsAggregation

FloatStatsAggregation

The field-based FloatStatsAggregation aggregates search results by the value of the Float field and provides statistical information for the values. You can use the provided getters to access the values:

• sum (getSum())
• count of values (getCount())
• minimum value (getMin())
• maximum value (getMax())
• average (getAvg())

Arguments

• name - name of the Aggregation
• contentTypeIdentifier - string representing the content type identifier
• fieldDefinitionIdentifier - string representing the Field Definition identifier

Example

You can use this Aggregation over the REST API, in the Aggregations element of the payload of the POST /views request:

"Query": {
    "Aggregations": [
        {
            "FloatStatsAggregation": {
                "name": "aggregation_name",
                "contentTypeIdentifier": "article",
                "fieldDefinitionIdentifier": "rating"
            }
        }
    ]
}

Copy as Markdown View as Markdown View on GitHub