Dixa
    Nothing Found

Search

Search conversationsDeprecated

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

SecurityApiKeyAuth
Request
query Parameters
exactMatch
boolean

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

pageKey
string

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

pageLimit
integer <int32>

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

query
required
string non-empty

The text by which to search conversations

Example: query=cancel my order
Responses
200

The search results for the searched parameters

400

Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter query, Invalid value for: query parameter exactMatch

401

The user who issued the access token used in the request is not authorized to perform the operation

500

Internal failure during request processing

get/beta/search/conversations
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 1234,
      • "highlights": {
        • "subject": [
          • "<em class=\"highlight\">Cancel my order</em>"
          ]
        },
      • "innerHits": [
        • {
          • "id": "dadcaea0-4135-4e8a-a5bf-05d4658facba",
          • "highlight": {
            • "text": "I want to <em class=\"highlight\">cancel my order</em> as soon as possible"
            }
          }
        ]
      }
    ]
}
Search conversations with filters
Search for conversations containing a particular text or by filter or combine them both


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


 
pageLimit
integer <int32> 
Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.


 
Request Body schema: application/json
optional
The filters to apply to the search


object (Filters) 
 
object (Query) 
 
Responses 
200
The search results for the searched parameters


400
Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: body


401
The user who issued the access token used in the request is not authorized to perform the operation


500
Internal failure during request processing


post/beta/search/conversations
Request samples 
application/json
{
  • "filters": {
    • "strategy": "All",
    • "conditions": [
      • {
        • "field": {
          • "operator": {
            • "values": [
              • "177e7564-6434-4177-a25a-8530089196ad",
              • "7729e7564-9876-a637-b46b-8530038196b3"
              ],
            • "_type": "IncludesOne"
            },
          • "_type": "TagId"
          }
        }
      ]
    }
}
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 1234,
      • "highlights": { }
      },
    • {
      • "id": 2345,
      • "highlights": { }
      },
    • {
      • "id": 3456,
      • "highlights": { }
      }
    ],
  • "meta": {
    • "next": "/beta/search/conversations/?pageKey=cGFnZUxpbWl0PTUwJnBhZ2U9MQ%3D%3D:"
    }
}
Why Dixa
Product
Capabilities
Resources
Solutions
Company
Call us now 
© Dixa 2025