Rating

Type key: rating. Renders a row of stars from which respondents pick a rating from 1 to rating_max. In the editor this is the Rating block.

A question: the question rules apply, and it can sit in a layout row column.

Meta fields

The meta fields of this node type are listed in the request body of Replace the draft document, under pages › nodes, in the rating tab.

Example

A minimal Rating node

{
  "public_id": "nRat",
  "sort_order": 1,
  "type": "rating",
  "meta": {
    "question": "<span>How was last year's event?</span>",
    "rating_max": 5,
    "validation": {
      "required": false
    }
  }
}

Defaults and rules

• rating_max accepts 1 to 10 and defaults to 5. rating_allow_half defaults to false; true offers half stars.
• default_value is a number; when the form renders it is clamped to the scale and rounded to a whole step, or a half step when rating_allow_half is true.