Skip to content
Dixa API/
/
Create conversation ratin...

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Add internal note

Request

Create an internal note in a conversation by providing the conversation id.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
Bodyapplication/jsonrequired

The internal note to create for a conversation

messagestringrequired
agentIdstring(uuid)
createdAtstring(date-time)
curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/notes' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "message": "A sample note",
    "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
    "createdAt": "2021-12-01T12:46:36.581Z[GMT]"
  }'

Responses

The created internal note

Bodyapplication/json
dataobject(InternalNoteData)required
data.​idstring(uuid)required
data.​authorIdstring(uuid)required
data.​createdAtstring(date-time)required
data.​csidinteger(int64)required
data.​messagestringrequired
Response
application/json
{
  "data": {
    "id": "eb31acbb-13f9-4ce7-abd3-44dd86266741",
    "authorId": "5e8a300e-787e-47cd-af53-fc1ccc37933d",
    "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
    "csid": 9456,
    "message": "A sample note"
  }
}

Create conversation rating result

Request

Create a rating result for a specific conversation.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
ratingIdstringrequired

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

Bodyapplication/jsonrequired

The rating result to be created for a conversation

ratingResultCsat (object) or Nps (object) or ThumbsUpOrDown (object)(SubmittedRatingResult)required
One of:
ratingResult.​valueinteger(int32)required

Numeric value between 1 and 5 representing the customer's satisfaction level.

commentstring
submittedAtstring(date-time)
userIdstringDeprecated

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.

curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/ratings/{ratingId}/submit' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "d3cf6f15-1497-4e71-92f2-9b3b228352bd",
    "ratingResult": {
      "value": 4,
      "_type": "Csat"
    },
    "comment": "Best customer service ever!",
    "submittedAt": "2024-03-11T16:39:30Z"
  }'

Responses

The created conversation rating result

Bodyapplication/json
dataobject(RatingResult)required
data.​ratingIdstringrequired
data.​userIdstring
data.​ratingResultCsat (object) or Nps (object) or ThumbsUpOrDown (object)(SubmittedRatingResult)required
One of:
data.​ratingResult.​valueinteger(int32)required

Numeric value between 1 and 5 representing the customer's satisfaction level.

data.​commentstring
data.​submittedAtstring(date-time)
Response
application/json
{
  "data": {
    "ratingId": "33cf4e5e-9ce9-461c-b668-be9b712b717c",
    "userId": "4c5f7efa-0822-4b75-bdf5-907fa7336e0c",
    "ratingResult": { … },
    "comment": "Excellent customer service!",
    "submittedAt": "2024-03-11T16:39:30Z"
  }
}

Create conversation rating offer

Request

Create a rating offer for a specific conversation.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
Bodyapplication/jsonrequired

The rating offer to be created for a conversation

userIdstringrequired
agentIdstringrequired

Please note that providing agentId that is not part of the conversation may skew metrics in Intelligence

ratingTypestringrequired

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

offeredAtstring(date-time)
curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/ratings/offer' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "b0323b42-c428-4afa-970e-20bf5bdeeec4",
    "agentId": "eeb3bbe5-0355-4ac1-8af5-20d42a3db24b",
    "ratingType": "Csat",
    "offeredAt": "2024-03-11T16:39:30Z"
  }'

Responses

The created conversation rating offer

Bodyapplication/json
dataobject(RatingOffer)required
data.​idstringrequired
data.​userIdstringrequired
data.​agentIdstringrequired
data.​ratingTypestringrequired

values: [Csat, Nps, ThumbsUpOrDown]

data.​offeredAtstring(date-time)
Response
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"
  }
}

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations