Linear Scale

Type key: rating_number. Renders a row of numbers from rating_start to rating_max, from which respondents pick one. For a fixed 0 to 10 recommendation question, use NPS. In the editor this is the Linear Scale 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_number tab.

Example

A minimal Linear Scale node

{
  "public_id": "nNps",
  "sort_order": 1,
  "type": "rating_number",
  "meta": {
    "question": "<span>How likely are you to recommend the meetup?</span>",
    "rating_max": 10,
    "validation": {
      "required": false
    }
  }
}

Defaults and rules

• rating_start and rating_max accept -10 to 10. rating_max defaults to 10, and an omitted rating_start starts the scale at 1.
• rating_reverse reverses the display order without changing the stored values.
• rating_labels shows the endpoint labels, rating_label_low and rating_label_high, which are inline rich text of up to 200 visible characters.
• default_value is a number; when the form renders it is clamped to the scale and rounded to a whole number.