Skip to main content
GET
/
ratings
/
{id}
Show rating by ID.
curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/ratings/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": 123,
    "code": "<string>",
    "stars": 123,
    "comment": "<string>",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chat.voicebot.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

Response

200 - application/json

Success

​
data
object

User fillable rating of a conversation. Users have 2 days to fill out the form. If 4 or 5 stars are given, the user will be redirected to a given URL (Google) to create a public review if configured.