Skip to content
Dixa API/
/
List organization activit...

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

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": [
    { … },
    { … }
  ]
}

List flows

Request

List all conversations flows in an organization.

Security
ApiKeyAuth
Query
channelstring

An optional ConversationChannel can be specified to filter the flows. If not provided, the default channel is PstnPhone. Possible values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Email, ContactForm, Callback, PstnPhone, Messenger]

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/flows?channel=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of conversation flows

Bodyapplication/json
dataArray of objects(ConversationFlow)
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