Learn about the other types used reading aggregated board data using the platform API
The monday.com aggregate API enables you to retrieve board data using groupings and aggregation functions via the API.
Each of the object types described below represents a specific aspect of an aggregation query. They can be provided as arguments to define an aggregation function or queried as fields.
🚧 The following types are only available in API versions 2026-01 and later
AggregateQueryInput
An object containing the aggregation query to execute.
Field | Description | Supported Fields |
|---|---|---|
The data source for the aggregation. | id | |
group_by | The fields to group results by. The default is 1,000. | column_id |
limit | The number of results to return. | |
query | The filters for the items being aggregated. Without it, all items will be returned. | groups |
The fields or functions to return. | as |
AggregateFromTableInput
An object containing the source table and its ID for the aggregation query.
| Field | Description | Enum Values |
|---|---|---|
id ID! | The unique identifier of the source (e.g., board ID). | |
type AggregateFromElementType! | The source type. | TABLE |
AggregateGroupByElementInput
An object containing the item limit and column to group results by.
| Field | Description |
|---|---|
column_id String! | The unique identifier of the column to group results by. |
limit Int | The number of results to return. The default is 1,000. |
AggregateSelectElementInput
An object containing the fields or functions to return.
Field | Description | Enum Values | Supported Fields |
|---|---|---|---|
as | The field's alias to be used in the result set. | ||
column | The column to select from the source. Required if type is | column_id | |
function | The function to apply to the specified fields. Required if type is | function | |
type | The source type. |
|
AggregateSelectFunctionInput
An object containing the function to apply to the specified fields.
Field | Description | Enum Values | Supported Fields |
|---|---|---|---|
function | The function name. |
| |
The arguments passed into the function. | as |
AggregateResultSet
An object containing the result of the aggregate query.
Field | Description | Supported Fields |
|---|---|---|
entries | A list of results, each representing either a grouping key or an aggregated value. | alias |
AggregateResultEntry
An object containing the field's name and value.
Field | Description | Possible Types |
|---|---|---|
alias | The name of the field, as defined using the | |
value | The value returned for the given alias. Can represent a group-by key or an aggregated metric. |
AggregateBasicAggregationResult
An object containing the result of the aggregation function.
| Field | Description |
|---|---|
result Float | The result from the aggregation function. |
AggregateGroupByResult
An object containing the field's group-by value.
| Field | Description |
|---|---|
value_boolean Boolean | The group‑by value for booleans. |
value_float Float | The group‑by value for decimal numbers. |
value_int Int | The group‑by value for whole numbers. |
value_string String | The string representation of the group‑by value. |
