Searching Interactions

You can include optional filters in a GET request to retrieve interactions that consider a specific subset of interaction parameters.

The following table provides samples of the optional filters that you can add to a basic request. Click the links to view a detailed example of the query.

Searching for? Query String Example
Contact ?contactId=<contactId> curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?contactID=93b34310-bfee-11e7-b9f2-01904e807d77
Custom reporting attributes

?attribute-value=<attributeValue>

or

?hook-name=<hookName>

curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?attribute-value=custAccountNumber

or

curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?hookName=custAccountNumber
Time range ?start=<startTimestamp>&<endTimestamp> curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?start=2017-12-29T14:00:00.000Z&end=2017-12-29T24:00:00.000Z
Third-party integrations ?hookType=<hookType> curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?hookType=zendesk
Third-party integrations and subtype ?hookType=<hookType&hookSubType=<hookSubType> curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?type=zendesk&hookSubType=ticket
Third-party integrations, subtype, and record ID ?hookType=<hookType&hookSubType=<hookSubType>&hookId=<hookId> curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?type=zendesk&hookSubType=ticket&hookId=12345

 

  If you are unable to search and get the results you are looking for, contact Customer Support for assistance.

Including Null Parameters

By default, responses for any interaction query includes only parameters that have values. If you want to return a response that includes all parameters, even those that have null values, you must add the ?includenulls=true filter. For example, curl GET https://api.cxengage.net/v1/tenants/7d23df20-2461-11e7-9bf4-b883f2d63b7b/interactions?contactID=93b34310-bfee-11e7-b9f2-01904e807d77?includenulls=true. To see a full example, see Returning All Parameters (Including Nulls) in a Response.

You might also be interested in: