Reviews
Ask a customer for a review, and read the ratings that come back.
The review object
As returned by GET /reviews, one element of the list. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | UUID |
request_idrequired | string (uuid) | null | The request it answers; null for a walk-in review |
contact_idrequired | string (uuid) | null | Who left it; null for an anonymous walk-in review |
form_idrequired | string (uuid) | null | The form it was submitted on |
form_namerequired | string | null | The form’s name when the review was submitted |
starsrequired | integer | The rating, 0 to 5 |
answersrequired | object[] | The customer’s answers, with each question as it read at the time |
answers[].question_idrequired | string | The question’s id on the form |
answers[].typerequired | string (enum) | The kind of questiontextscaleyes_no |
answers[].labelrequired | string | The question as the customer saw it |
answers[].valuerequired | string | number | boolean | What they answered |
gate_passedrequired | boolean | True when the rating met the account’s threshold, so the customer was shown the public review platforms |
is_alertrequired | boolean | True for a low rating that was kept private and flagged for the team |
alert_acknowledged_atrequired | string (date-time) | null | When a member acknowledged the alert |
created_atrequired | string (date-time) | ISO 8601 timestamp |
Endpoints
7 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.