Skip to content
Dixa API/
/
List ratings for a conver...

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

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"
  }
}

List ratings for a conversation

Request

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.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/ratings' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of ratings for a conversation

Bodyapplication/json
dataArray of objects(ConversationRating)
Response
application/json
{
  "data": [
    { … }
  ]
}

List organization activity log

Request

List all activity logs for an organization.

Security
ApiKeyAuth
Query
pageLimitinteger(int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

fromDatetimestring(date-time)

Starting date-time filter with ISO 8601 format: yyyy-MM-dd'T'HH:mm:sss'Z'

toDatetimestring(date-time)

Ending date-time filter with ISO 8601 format: yyyy-MM-dd'T'HH:mm:sss'Z'

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/activitylog?pageLimit=0&pageKey=string&fromDatetime=2019-08-24T14%3A15%3A22Z&toDatetime=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The full list of activity logs for an organization with pagination

Bodyapplication/json
dataArray of objects(ActivityLogEntry)
metaobject(PaginationLinks)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

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