Skip to content

Aggregation reference

Aggregation is used to group search results into categories.

There are three types of aggregations:

  • Term aggregations group by value and count object in each group
  • Range aggregations count values in specified ranges
  • Stats aggregations compute stats over numeric fields: minimum, average and maximum value, count and sum of values

Content aggregations

Name Type Based on
ContentTypeTermAggregation Term Content Type
ContentTypeGroupTermAggregation Term Content Type group
DateMetadataRangeAggregation Range Date metadata
LocationChildrenTermAggregation Term Children on a Location
LanguageTermAggregation Term Content language
ObjectStateTermAggregation Term Object state
RawRangeAggregation Range Search index field
RawStatsAggregation Stats Search index field
RawTermAggregation Term Search index field
SectionTermAggregation Term Section
SubtreeTermAggregation Term Location subtree path
UserMetadataTermAggregation Term Content owner/owner group or modifier
VisibilityTermAggregation Term Content/Location visibility

Field aggregations

Name Type Based on Field
AuthorTermAggregation Term Author
CheckboxTermAggregation Term Checkbox
CountryTermAggregation Term Country
DateRangeAggregation Range Date
DateTimeRangeAggregation Range DateTime
FloatRangeAggregation Range Float
FloatStatsAggregation Stats Float
IntegerRangeAggregation Range Integer
IntegerStatsAggregation Stats Integer
KeywordTermAggregation Term Keyword
SelectionTermAggregation Term Selection
TimeRangeAggregation Range Time