AggregationField

A single aggregation computed over the documents matching the query

type AggregationField {
  aggregations: [AggregationField]
  customization_name: String
  customization_property_name: String
  field_name: String
  name: String!
  profile_property_name: String
  profile_type: String
  size: Int
  sort: AggregationSort
  type: AggregationTypeEnum
}

Fields

aggregations (AggregationField)

Sub-aggregations computed separately for every bucket of this aggregation. Only used together with field_name

customization_name (String)

Legacy: not used

customization_property_name (String)

Legacy: property of customizations attached to user profiles of profile_type
to aggregate on, for the deprecated people query

field_name (String)

Field to aggregate on, e.g. properties.color or created_at. For a
properties. field the exact (not analyzed) value is used

name (String)

Key under which the result of this aggregation is returned

profile_property_name (String)

Legacy: user profile property to aggregate on instead of field_name, for the deprecated people query

profile_type (String)

Legacy: user profile type that profile_property_name and
customization_property_name aggregations are restricted to; required with
customization_property_name

size (Int)

Maximum number of buckets returned by a terms aggregation

sort (AggregationSort)

Order of the buckets of a terms aggregation. When omitted, field_name
aggregations are ordered by document count descending, and
profile_property_name / customization_property_name aggregations by value ascending

type (AggregationTypeEnum)

Kind of aggregation computed for field_name. profile_property_name and
customization_property_name aggregations are always terms aggregations