Skip to content
/Search

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

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

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

Search conversationsDeprecated

Request

NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text.

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.

querystringnon-emptyrequired

The text by which to search conversations

Example: query=cancel my order
exactMatchboolean

Return only exact matches. This value is false by default.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/search/conversations?pageLimit=0&pageKey=string&query=cancel+my+order&exactMatch=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The search results for the searched parameters

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

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations