Get Interactions based on filter criteria.

post deprecated

https://api.authcx.com/Interactions

Deprecated. Please use /Conversations/Insights instead.

Returns a list of interactions that have finished processing and match the specified criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request model for filtering interactions for POST requests.

dateReference

string | null

Specifies whether to filter by 'InteractionDate' or 'ArrivalDate'.

startDate

string

required

length ≥ 1

The start date for filtering interactions. Format: YYYY-MM-DDTHH:MM:SS.

endDate

string

required

length ≥ 1

The end date for filtering interactions. Format: YYYY-MM-DDTHH:MM:SS.

status

string | null

The status filter for interactions. Valid values: 'Sampled', 'ReadyToSample'.

eddyEffect

string | null

Boolean filter for the Eddy Effect model results. Valid values: 'true', 'false'.

lastId

string | null

The last Interaction ID (excluded) to start pagination from.

pageSize

int32 | null

The number of results to return per call. Must be an integer between 1 and 20.

hierarchyIds

array of strings | null

A list of GUIDs representing the hierarchy IDs to filter interactions by organizational structure.

hierarchyIds

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

If the request parameters are invalid.

404

If no interactions meet the criteria.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the interactions that match the specified criteria.