Skip to content
Dixa API/
/
Search conversations with...

Dixa API (v1)

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

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

List linked conversations

Request

Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations.

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

Responses

The list of conversations requested by an EndUser

Bodyapplication/json
dataArray of AnonymizedConversation (object) or ChatConversation (object) or ContactFormConversation (object) or EmailConversation (object) or FacebookMessengerConversation (object) or GenericConversation (object) or MessengerConversation (object) or PstnPhoneConversation (object) or SmsConversation (object) or TwitterConversation (object) or WhatsAppConversation (object)(Conversation)
Response
application/json
{
  "data": [
    { … }
  ]
}

Search conversations with filters

Request

Search for conversations containing a particular text or by filter or combine them both

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.

Bodyapplication/json

The filters to apply to the search

queryobject(Query)
filtersobject(Filters)
curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/search/conversations?pageLimit=0&pageKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": {
      "strategy": "All",
      "conditions": [
        {
          "field": {
            "operator": {
              "values": [
                "177e7564-6434-4177-a25a-8530089196ad",
                "7729e7564-9876-a637-b46b-8530038196b3"
              ],
              "_type": "IncludesOne"
            },
            "_type": "TagId"
          }
        }
      ]
    }
  }'

Responses

The search results for the searched parameters

Bodyapplication/json
dataArray of objects(ConversationSearchWithFiltersHit)
metaobject(PaginationLinks)
Response
application/json
{
  "data": [
    { … },
    { … },
    { … }
  ],
  "meta": {
    "next": "/<api-version>/search/conversations/?pageKey=cGFnZUxpbWl0PTUwJnBhZ2U9MQ%3D%3D:"
  }
}

List ratingDeprecated

Request

Deprecated rating endpoint. Use '/ratings'.

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

Responses

List of ratings for a conversation

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