rating
Your app's own question about how something went, answered with a tap.
How did it go? rating asks the user to score something — the delivery, the visit, the help they just had — on five stars, a thumb, or a 0–10 scale, with a few words if they want.
The answer is recorded at once, without coming back to the model: the SDK sends POST /v1/ratings with the block's id and the score, and the server checks the score against the block's own scale. One answer per device per block; a second tap changes it.
Re-rendered in the browser from the SDK’s own scales. Not a screenshot.
When the copilot asks
At most once in a conversation, only once the user's job is done, and never as the whole answer. The server holds it to that: a second rating in a conversation, or one on a page that still asks the user for something (a form, a choice), is not shown.
Props
Every block also carries type and a required fallback_text of 1 to 300 characters.
| Prop | Type | Required | Constraints |
|---|---|---|---|
question | string | Yes | 1 to 120 characters. |
scale | stars_5 | thumbs | nps_11 | Yes | None |
low_label | string | No | Up to 30 characters. |
high_label | string | No | Up to 30 characters. |
comment | object | No | None |
comment.placeholder | string | No | Up to 80 characters. |