Numbers
The numbers column holds number values (either floats or ints). Our API fully supports the numbers column, so you can filter, read, update, and clear it via the API.
Filtering the numbers column
Using the items_page
object, you can easily filter a board's items by specific columns or column values. The table below contains the number column's supported operators and compare values.
Operators | Compare values |
---|---|
any_of | "$$$blank$$$" (blank values) |
not_any_of | "$$$blank$$$" (blank values) |
is_empty | null |
is_not_empty | null |
greater_than | The numeric value to filter by |
greater_than_or_equals | The numeric value to filter by |
lower_than | The numeric value to filter by |
lower_than_or_equals | The numeric value to filter by |
Pro tip
items_page
is only available in API version2023-10
for now.
The following example returns all items on the specified board with a number column value greater than 5.
query {
boards (ids: 1234567890) {
items_page (query_params: {rules: [{column_id: "numbers", compare_value: [5], operator:greater_than}]}) {
items {
id
name
}
}
}
}
Reading the numbers column
You can query the numbers column using the column_values
object. The object has different fields based on which API version you are using. Column values v2 fields will be available in API versions 2023-10
and later, while column values v1 fields are only supported in versions 2023-07
and 2023-04
.
Column values v2
The column_values
object enables you to return column-specific subfields by sending a fragment in your query. Values for the numbers column are of the NumbersValue
type.
Pro tip
column_values
v2 fields are only available in API version2023-10
.
query {
items (ids:[1234567890, 9876543210]) {
column_values {
... on NumbersValue {
number
id
}
}
}
}
Fields
Field | Description |
---|---|
columnColumn! | The column the value belongs to. |
id ID! | The column's unique identifier. |
number Float | The column's number value. |
text String | The column's value as text. |
type ColumnType! | The column's type. |
value JSON | The column's JSON-formatted raw value. |
Column values v1
You can return the data in a numbers column in two different formats when you query by column values. The text
field will return the number as a simple string. The value
field will return metadata about the column as a JSON string.
Removing column values v1 support
column_values
v1 fields will no longer be supported in API versions2023-10
and later.
{
"text": "1000",
"value": "\"1000\""
}
Updating the numbers column
You can update a numbers column using the change_simple_column_value
mutation and sending a simple string in the value
argument. You can also use the change_multiple_column_values
mutation and pass a JSON string in the column_values
argument.
Simple strings
To update the numbers column, send a string containing a float or int.
mutation {
change_simple_column_value (item_id:9876543210, board_id:1234567890, column_id:"numbers", value: "3") {
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValue: String!, $columnId: String!) { change_simple_column_value (item_id:$myItemId, board_id:$myBoardId, column_id: $columnId, value: $myColumnValue) { id } }",
variables : JSON.stringify({
myBoardId: 1234567890,
myItemId: 9876543210,
columnId: "numbers",
myColumnValue: "3"
})
})
})
JSON
To update the numbers column using JSON, send a string containing a float or int. Check out this mutation in action in our Postman library or follow along with these code samples!
mutation {
change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"numbers\" : \"3\"}") {
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY'
},
body: JSON.stringify({
query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValues:JSON!) { change_multiple_column_values(item_id:$myItemId, board_id:$myBoardId, column_values: $myColumnValues) { id }}",
variables : JSON.stringify({
myBoardId: 1234567890,
myItemId: 9876543210,
myColumnValues: "{\"numbers\" : \"3\"}"
})
})
})
Clearing the numbers column
You can also clear a numbers column using the change_multiple_column_values
mutation and passing null
or an empty string in the column_values
argument. Check out this mutation in action in our Postman library or follow along with these code samples!
mutation {
change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"numbers\" : null}") {
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValues:JSON!) { change_multiple_column_values(item_id:$myItemId, board_id:$myBoardId, column_values: $myColumnValues) { id } }",
variables : JSON.stringify({
myBoardId: 1234567890,
myItemId: 9876543210,
myColumnValues: "{\"numbers\" : null}"
})
})
})
Join our developer community!
We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎
Updated 3 months ago