Other types

Learn about other types supported by the aggregate API

The monday.com aggregate API enables you to read board data using groupings and aggregation functions.

The types below are used by the aggregate query and are not independently queryable.

AggregateQueryInput

An object containing the aggregation query to execute.

FieldTypeDescription
fromAggregateFromTableInput!The data source for the aggregation.
group_by[AggregateGroupByElementInput!]The fields to group results by. The default limit per group is 1,000.
limitIntThe maximum number of result groups to return. Only applies when using group_by.
queryItemsQueryThe filters for the items being aggregated. Without it, all items will be included.
select[AggregateSelectElementInput!]!The fields or functions to return.

AggregateFromTableInput

An object containing the source table and its ID for the aggregation query.

FieldTypeDescriptionEnum Values
idID!The unique identifier of the source (e.g., board ID).
typeAggregateFromElementType!The source type.TABLE

AggregateGroupByElementInput

An object containing the item limit and column to group results by.

FieldTypeDescription
column_idString!The unique identifier of the column to group results by. Can also be an alias from a transformative function.
limitIntThe number of groups to return. The default is 1,000.

AggregateSelectElementInput

An object containing the fields or functions to return.

FieldTypeDescriptionEnum Values
asString!The field's alias in the result set. For columns used in group_by, the alias must match the column_id in the group_by array.
columnAggregateSelectColumnInputThe column to select from the source. Required if type is COLUMN.
functionAggregateSelectFunctionInputThe function to apply to the specified fields. Required if type is FUNCTION.
typeAggregateSelectElementType!Whether this element is a column reference or a function call.COLUMN
FUNCTION

AggregateSelectColumnInput

An object containing the column to select from the source.

FieldTypeDescription
column_idString!The column's unique identifier.

AggregateSelectFunctionInput

An object containing the function to apply to the specified fields.

FieldTypeDescriptionEnum Values
functionAggregateSelectFunctionName!The function name.AVERAGE
BETWEEN
CASE
COLOR
COUNT
COUNT_DISTINCT
COUNT_ITEMS
COUNT_KEYS
COUNT_SUBITEMS
DATE
DATE_TRUNC_DAY
DATE_TRUNC_MONTH
DATE_TRUNC_QUARTER
DATE_TRUNC_WEEK
DATE_TRUNC_YEAR
DURATION_RUNNING
END_DATE
EQUALS
FIRST
FLATTEN
HOUR
ID
IS_DONE
LABEL
LEFT
LENGTH
LOWER
MAX
MEDIAN
MIN
MIN_MAX
NONE
ORDER
PERSON
PHONE_COUNTRY_SHORT_NAME
RAW
START_DATE
SUM
TRIM
UPPER
params[AggregateSelectElementInput!]The arguments passed into the function. For column-based functions (e.g., SUM, AVERAGE), pass a COLUMN type element with the target column_id. Not required for item-level functions like COUNT_ITEMS.

AggregateResultSet

An object containing the result of the aggregate query. When using group_by, each AggregateResultSet represents one group.

FieldTypeDescription
entries[AggregateResultEntry!]A list of results, each representing either a grouping key or an aggregated value.

AggregateResultEntry

An object containing the field's name and value.

FieldTypeDescriptionPossible Types
aliasStringThe name of the field, as defined using the as field. Used to map the result to its corresponding expression.
valueAggregateResultThe value returned for the given alias. Can represent a group-by key or an aggregated metric.AggregateBasicAggregationResult
AggregateGroupByResult

AggregateBasicAggregationResult

An object containing the result of the aggregation function.

FieldTypeDescription
resultFloatThe numeric result from the aggregation function. Returns null when all values in the group are null or the column is empty.

AggregateGroupByResult

An object containing the group-by value. The value field returns a JSON value whose type depends on the source column.

🚧

Breaking change in API versions 2026-04 and later: The value_string, value_int, value_float, and value_boolean fields have been removed and replaced by a single unified value field of type JSON. Consumers that reference the old typed fields must migrate to the value field and handle type coercion on the client side.

FieldTypeDescription
valueJSONThe group-by value. Type varies: strings for text/status (hex codes), booleans for checkboxes, numbers for dates (epoch ms).
API VersionAvailable FieldsNotes
Before 2026-04value_string, value_int, value_float, value_booleanSeparate typed fields
2026-04 and latervalue (JSON)Unified field — handle type coercion client-side
📘

Group by value format reference

Column TypeValue FormatExample
StatusHex color code"#00c875"
PeoplePerson ID string"person-12345"
CheckboxBooleantrue
TextPlain string"Category A"
DateEpoch timestamp (ms)1768435200000
NumbersNumeric value42