NPS

Type key: nps. Renders a Net Promoter Score question on a fixed 0 to 10 scale. In the editor this is the NPS 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 nps tab.

Example

A minimal NPS node

{
  "public_id": "nRec",
  "sort_order": 1,
  "type": "nps",
  "meta": {
    "question": "<span>How likely are you to recommend us?</span>"
  }
}

Defaults and rules

• The range is always 0 to 10. For a custom range, use Linear Scale.
• Score groups are fixed: detractors 0 to 6, passives 7 to 8, and promoters 9 to 10.
• nps_display selects numbers or smileys; both store the numeric score. rating_reverse reverses the display order without changing the stored values.
• nps_colors colors the score groups and nps_legend shows their legend. nps_legend_detractors, nps_legend_passives, and nps_legend_promoters rename the groups, as plain text of up to 40 characters.
• default_value is a number; when the form renders it is clamped to 0 to 10 and rounded to a whole number.