Dixa
    Nothing Found

Ratings

Create conversation rating offer

Create a rating offer for a specific conversation.

SecurityApiKeyAuth
Request
path Parameters
conversationId
required
integer <int64>
Request Body schema: application/json
required

The rating offer to be created for a conversation

agentId
required
string
offeredAt
string <date-time>
ratingType
required
string

The type of numeric rating. E.g.: 'Csat', 'ThumbsUpOrDown', 'Nps'.

userId
required
string
Responses
201

The created conversation rating offer

400
500

Internal failure during request processing

post/beta/conversations/{conversationId}/ratings/offer
Request samples
application/json
{
  • "userId": "b0323b42-c428-4afa-970e-20bf5bdeeec4",
  • "agentId": "eeb3bbe5-0355-4ac1-8af5-20d42a3db24b",
  • "ratingType": "Csat",
  • "offeredAt": "2024-03-11T16:39:30Z"
}
Response samples
application/json
{
  • "data": {
    • "id": "2f0122db-0824-44d7-b39a-e1f722b8c38c",
    • "userId": "7a65c963-b3ca-4bd4-996e-bdbcaa620219",
    • "agentId": "db7f0b41-b779-4726-a673-07b2a59a550d",
    • "ratingType": "Csat",
    • "offeredAt": "2024-03-11T16:39:30Z"
    }
}

Create conversation rating result

Create a rating result for a specific conversation.

SecurityApiKeyAuth
Request
path Parameters
conversationId
required
integer <int64>
ratingId
required
string

The ratingId parameter has to be the ID of the offer created via invoking the /conversations/{conversationId}/ratings/offer endpoint.

Request Body schema: application/json
required

The rating result to be created for a conversation

comment
string
required
Csat (object) or Nps (object) or ThumbsUpOrDown (object) (SubmittedRatingResult)
submittedAt
string <date-time>
userId
string
Deprecated

The userId property is no longer used so it's made optional to keep backwards compatibility. A null value can be provided instead of an actual ID.

Responses
201

The created conversation rating result

400
500

Internal failure during request processing

post/beta/conversations/{conversationId}/ratings/{ratingId}/submit
Request samples
application/json
{
  • "userId": "d3cf6f15-1497-4e71-92f2-9b3b228352bd",
  • "ratingResult": {
    • "value": 4,
    • "_type": "Csat"
    },
  • "comment": "Best customer service ever!",
  • "submittedAt": "2024-03-11T16:39:30Z"
}
Response samples
application/json
{
  • "data": {
    • "ratingId": "33cf4e5e-9ce9-461c-b668-be9b712b717c",
    • "userId": "4c5f7efa-0822-4b75-bdf5-907fa7336e0c",
    • "ratingResult": {
      • "value": 5,
      • "_type": "Csat"
      },
    • "comment": "Excellent customer service!",
    • "submittedAt": "2024-03-11T16:39:30Z"
    }
}

List ratingDeprecated

Deprecated rating endpoint. Use '/ratings'.

SecurityApiKeyAuth
Request
path Parameters
conversationId
required
integer <int64>
Responses
200

List of ratings for a conversation

400

Invalid value for: path parameter conversationId, Invalid value extracted from request context

404

An entity in this request could not be found

500

Internal failure during request processing

get/beta/conversations/{conversationId}/rating
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "33cf4e5e-9ce9-461c-b668-be9b712b717c",
      • "ratingScore": 4,
      • "ratingType": "Csat",
      • "ratingComment": "Super good!",
      • "conversationChannel": "PstnPhone",
      • "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
      • "userId": "6d0c5791-e40a-46d4-bba1-1364ce4578ed",
      • "ratingStatus": "Offered",
      • "language": "English",
      • "timestamps": { }
      }
    ]
}
List ratings for a conversation
Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the survey. For example, a response for a 3 question survey that was answered will be 3 elements with status "Rated". Additionally, a multiple question survey can be partially answered, therefore a response of such case will be a mix of "Offered" and "Rated" statuses. Note that the IDs of multiple questions response elements will be the same, because they are part of the same survey.


SecurityApiKeyAuth 
Request 
path Parameters
conversationId
required
integer <int64> 
 
Responses 
200
List of ratings for a conversation


400
Invalid value for: path parameter conversationId, Invalid value extracted from request context


404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/conversations/{conversationId}/ratings
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "33cf4e5e-9ce9-461c-b668-be9b712b717c",
      • "ratingScore": 5,
      • "ratingType": "Csat",
      • "ratingComment": "Super good!",
      • "conversationChannel": "PstnPhone",
      • "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
      • "userId": "6d0c5791-e40a-46d4-bba1-1364ce4578ed",
      • "ratingStatus": "Offered",
      • "language": "en",
      • "timestamps": {
        • "offered_at": "2025-09-25T14:35:53Z",
        • "modified_at": "2025-09-25T14:36:27Z",
        • "scheduled_for": "2025-09-25T14:35:52Z",
        • "created_at": "2025-09-25T14:34:52Z",
        • "scheduled_at": "2025-09-25T14:34:52Z"
        }
      }
    ]
}
Why Dixa
Product
Capabilities
Resources
Solutions
Company
Call us now 
© Dixa 2025