Rating (Stars)
Clickable star scale (1–N). Stores an integer score; optional reporting and integration keys match other advanced fields.
Overview
The Rating field shows a row of stars. Respondents tap the star count that reflects satisfaction, quality, or agreement. It is a compact alternative to long radio grids for single-dimension scores.
Set the ceiling with ratingMax (defaults to 5 in the renderer). The UI shows a numeric readout and a clear action when supported.
Tip: For scales drawn as a slider rather than stars, use the Range / Slider field.
Properties
Note: Exports use ratingMax (not maxRating) and id for submission keys.
| Property | Type | Default | Description |
|---|---|---|---|
| id | string | — | Unique field identifier. |
| type | string | "rating" | Discriminator. |
| label | string | — | Human-readable label shown above the field or step heading. |
| required | boolean | false | When true, the form cannot submit without a value. |
| isHidden | boolean | false | Hides the field from respondents (may still store defaults). |
| isDisabled | boolean | false | Renders the field read-only. |
| instruction | string | undefined | Help text shown below the label (not the same as placeholder). |
| ratingMax | number | 5 | Highest selectable score (number of stars). |
| placeholder | string | undefined | Optional hint (stars rarely show placeholder text). |
| analytics | object | undefined | Optional analytics (e.g. metric_key, weight). |
| reporting | object | undefined | Admin tables: includeInTable, labelOverride, sortable, filterable. |
| integrationKey | string | undefined | Stable alias for exports or external systems. |
JSON examples
{
"name": "hi-helo",
"weightage": 0,
"fields": [
{
"id": "6bb45c1e-6bf6-4f5b-9b12-6335a67cc712",
"type": "rating",
"label": "Overall experience",
"required": true,
"isHidden": false,
"placeholder": "Enter rating...",
"ratingMax": 5
}
]
}Stored value
An integer from 1 through ratingMax when answered. If the field is optional and cleared, omit the answer in the payload so validation treats it as unset.
Use cases
- Post-support or post-visit satisfaction in one tap
- Course, product, or content quality without a long matrix
- Pulse surveys paired with an optional comment field
- UX “how intuitive was this step?” alongside task success metrics