a!queryAggregationColumn() Function

Creates an AggregationColumn object for use inside an Aggregation object.


a!queryAggregationColumn( field, alias, visible, isGrouping, aggregationFunction )

  • field (Text): The dot-notation to the field of the data, such as a record type, you want to group together and/or aggregate. The fields cannot be complex or multiple values.
  • alias (Text): The short name by which the result of the AggregationColumn value can be referenced in other places of the Query value. Values are case-sensitive.
  • visible (Boolean): (Optional) Determines whether the grouping or aggregation column should be visible to end users. If false, the data for the column will not be retrieved, but it can be used for sorting. Default value is true.
  • isGrouping (Boolean): (Optional) Determines whether the field should be grouped. Default value is false.
  • aggregationFunction (Text): The function to use when aggregating the field. Valid values include COUNT, SUM, AVG, MIN, and MAX. This value is required when isGrouping is set to false but is optional when isGrouping is true.



See Also

Aggregation: The Aggregation data type defines the grouping and aggregation configuration to be applied when querying data.

AggregationColumn: The AggregationColumn data type defines an individual configuration of grouping and aggregation to be applied when querying data.

Query: The Query data type defines the grouping, aggregation, filtering, paging, and sorting configuration to be applied when querying data.

Open in Github

On This Page