List of available ratings

GET

ratings

List all ratings across conversations. Sorted by latest.

curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/ratings \
  --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"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "to": 123,
    "last_page": 123,
    "per_page": 123,
    "total": 123,
    "path": "<string>",
    "links": [
      "<unknown>"
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

only_rated

integer

Optional flag to only fetch ratings which the user has completed.

Example:

1

Response

200 - application/json

Success

data

object[]

Default count: 100

Show child attributes

links

object

Show child attributes

meta

object

Show child attributes

Show Rating by IDShow rating by ID.

List all ratings across conversations. Sorted by latest.

curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/ratings \
  --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"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "to": 123,
    "last_page": 123,
    "per_page": 123,
    "total": 123,
    "path": "<string>",
    "links": [
      "<unknown>"
    ]
  }
}