Rating questions

Three question types ask for one value on a scale. They share the common question keys and all store the answer as a number.

`type`	Name in the editor	Points	Values	Answer type
`rating`	Rating	3 to 10	1 to the number of points	`number`
`customer_sat`	Satisfaction score	2 to 5	1 to the number of points	`number`
`opinion_scale`	NPS	11	0 to 10	`number`

Scale labels

All three types keep the texts shown under the scale in properties.labels, a list of three strings: left, middle and right. An empty string shows nothing.

"labels": ["Poor", "", "Excellent"]

The left and right labels appear on scales with five or more points. The middle label appears on scales with ten or more points.

`rating`

A scale of icons or numbers.

Properties

Key	Type	Default	Description
`description`	string	`""`	Text under the question title.
`icon`	string	`"numbers"`	Icon. `stars`, `hearts`, `circles` or `numbers`.
`icon_count`	integer	`5`	Number of points. 3 to 10.
`labels`	string[3]	`["", "", ""]`	Scale labels.

Validations: required only.

Example

{
  "id": "Kp3sVn7YtR1w",
  "ref": "9d0b2c4e-6a81-4f37-b5c9-0e2a4c6f8b13",
  "type": "rating",
  "title": "How would you rate the delivery?",
  "properties": {
    "description": "",
    "icon": "stars",
    "icon_count": 5,
    "labels": ["Poor", "", "Excellent"]
  },
  "validations": { "required": true },
  "media": false
}

Answer

A value from 1 to icon_count, stored as a string.

{ "type": "number", "number": "4" }

`customer_sat`

A satisfaction question. Results show it as a CSAT score.

Properties

Key	Type	Default	Description
`description`	string	`""`	Text under the question title.
`icon`	string	`"numbers"`	Icons. `numbers`, `faces-mono` (faces in one color), `faces-color` (faces in five colors) or `emoji`.
`icon_count`	integer	`5`	Number of points. 2 to 5.
`labels`	string[3]	`["", "", ""]`	Scale labels.

Forms made before the current face styles may hold older icon values. They display as follows.

Stored value	Shown as
`smileys`, `animated-smileys`	`faces-color`
`outline-smileys`	`faces-mono`

Validations: required only.

Answer

A value from 1 to icon_count, stored as a string. The highest value is the most satisfied answer, also when the scale shows faces or emoji.

{ "type": "number", "number": "5" }

`opinion_scale`

A Net Promoter Score question: eleven buttons from 0 to 10.

Properties

Key	Type	Default	Description
`description`	string	`""`	Text under the question title.
`icon`	string	`"numbers"`	Always `numbers`.
`icon_count`	integer	`11`	Always 11: the values 0 to 10. The editor has no setting for it.
`labels`	string[3]	`["Not likely at all", "", "Extremely likely"]`	Scale labels. The defaults are in the editor’s language.

A new NPS question starts with the title “How likely are you to recommend us to a friend or colleague?”.

Validations: required only.

Example

{
  "id": "Xe5gHu8JiM2o",
  "ref": "4b6d8f0a-1c93-4e25-a7db-2f4c6e8a0d35",
  "type": "opinion_scale",
  "title": "How likely are you to recommend us to a friend or colleague?",
  "properties": {
    "description": "",
    "icon": "numbers",
    "icon_count": 11,
    "labels": ["Not likely at all", "", "Extremely likely"]
  },
  "validations": { "required": true },
  "media": false
}

Answer

A value from 0 to 10, stored as a string.

{ "type": "number", "number": "9" }