Rating

The rating field is used to store an integer value on a predetermined scale. The field has the option of being on a scale of 1 to 5, or 1 to 10.

When updating the value of a rating field, the API will accept either an integer to represent the rating value, or the option ID of a value, in the same way dropdown fields can be updated:

[{
  "id": "<rating_field_id>",
  "value": 5
},
{
  "id": "<rating_field_id>",
  "value": {
    "id": "<rating_option_id>"
  }
}]

In this partial field update payload, a rating field is shown to be updatable using either an integer value, or option ID. See the Kizen API docs for more information.

Field Display

On an entity record detail page or the table view, the rating field shows as a dropdown, which allows the user to select a value within the predefined range.