The rating column holds rating information for your item(s) which can be useful for ranking or assigning a grade to your item(s). Our API fully supports the rating column, so you can filter, read, update, and clear it via the API.

Filtering the rating 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 rating column's supported operators and compare values.

👍

Pro tip

items_page is only available in API version 2023-10 for now.

The following example returns all items on the specified board without a blank rating column.

query {
  boards (ids:1234567890) {
    items_page (query_params: {rules: {column_id: "rating", compare_value:[0], operator:not_any_of }}) {
      items {
        id
      }
    }
  }
}

Reading the rating column

You can query the rating 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 rating column are of the RatingValue type.

👍

Pro tip

column_values v2 fields are only available in API version 2023-10.

query {
  items (ids:[1234567890, 9876543210]) {
    column_values {
      ... on RatingValue {
        rating
        updated_at
      }
    }
  }
}

Fields

Column values v1

You can return the data in a rating column in two different formats when you query by column values. The text field will return the rating 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 versions 2023-10 and later.

{
  "text": "5",
  "value": "{\"rating\":5,\"changed_at\":\"2022-07-21T12:00:00.000Z\"}"
}

Updating the rating column

You can update a rating column using the change_multiple_column_values mutation and passing a JSON string in the column_values argument. Simple string updates are not supported.

JSON

To update a rating column using JSON, send a number between 1 and your rating scale. If you'd like to adjust your rating scale, you can do so in the column settings!

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: "{\"rating\" : {\"rating\" : 5}}") {
    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: "{\"rating\" : {\"rating\" : \"5\"}}"
      })
    })
  })
})

Clearing the rating column

You can also clear a rating column using the change_multiple_column_values mutation and passing null or an empty object in the column_values argument.

mutation {
  change_multiple_column_values(item_id:9876543210, board_id:123456789, column_values: "{\"rating\" : 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: "{\"rating\" : 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! 😎