Skip to main content
Version: 2025-03-11

AggregateStatsData

Contains the aggregated data from the aggregateStats query

type AggregateStatsData {
  avg(
    field: String
  ): Float
  cardinality(
    fields: [String]
  ): Int
  count(
    field: String
  ): Int
  filter(
    filters: [AggregateStatsFilter]
  ): AggregateStatsData
  max(
    field: String
  ): Float
  min(
    field: String
  ): Float
  rate(
    fields: [String]
  ): Float
  subtract(
    fields: [String]
  ): Float
  sum(
    field: String
  ): Float
  term(
    field: String
  ): String
  termBucket(
    fields: [String]
    hidden: Boolean
    limit: Int = 10
    offset: Int
    sort: [AggregateStatsSort]
  ): [AggregateStatsData]
}

Fields​

AggregateStatsData.avg ● Float scalar​

Compute the average value of a field

AggregateStatsData.avg.field ● String scalar​

field

AggregateStatsData.cardinality ● Int scalar​

Find the number of distinct values for 1 field OR find the number of distinct combinations present for >1 fields

AggregateStatsData.cardinality.fields ● [String] list scalar​

fields

AggregateStatsData.count ● Int scalar​

Count specific field

AggregateStatsData.count.field ● String scalar​

field

AggregateStatsData.filter ● AggregateStatsData object​

Apply additional filters to a subset within the aggregateStats query

AggregateStatsData.filter.filters ● [AggregateStatsFilter] list input​

filters

AggregateStatsData.max ● Float scalar​

Find the biggest value in a field

AggregateStatsData.max.field ● String scalar​

field

AggregateStatsData.min ● Float scalar​

Find the smallest value in a field

AggregateStatsData.min.field ● String scalar​

field

AggregateStatsData.rate ● Float scalar​

Compute a rate/percentage value between two field

AggregateStatsData.rate.fields ● [String] list scalar​

field

AggregateStatsData.subtract ● Float scalar​

Find the difference between fields

AggregateStatsData.subtract.fields ● [String] list scalar​

fields

AggregateStatsData.sum ● Float scalar​

Compute the sum value of a field

AggregateStatsData.sum.field ● String scalar​

field

AggregateStatsData.term ● String scalar​

Select a term within a term bucket (only usable for fields which being used as fields on term bucket)

AggregateStatsData.term.field ● String scalar​

field

AggregateStatsData.termBucket ● [AggregateStatsData] list object​

Group the data by term into different buckets

AggregateStatsData.termBucket.fields ● [String] list scalar​

List of fields to use for aggregation

AggregateStatsData.termBucket.hidden ● Boolean scalar​

Whether or not to show the field as part of the result

AggregateStatsData.termBucket.limit ● Int scalar​

Limit of results returned, with a maximum value of 100 and a default value of 10

AggregateStatsData.termBucket.offset ● Int scalar​

Omit a specified number of rows before the beginning of the results

AggregateStatsData.termBucket.sort ● [AggregateStatsSort] list input​

Sort by one or multiple fields or referenced fields by specifying name of field and order

Member Of​

AggregateStats object ● AggregateStatsData object