ConversationsAnalytics

Get interactions

View as Markdown
Fetch paginated interactions with filtering and sorting options

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
app_idstringRequired
Agent ID

Headers

X-API-Keystring or nullOptional

Query parameters

sort_bystring or nullOptional
Field to sort by
sort_orderstring or nullOptional

Sort order (asc or desc)

start_datetimedatetimeRequired

Filter start datetime in UTC (ISO8601)

end_datetimedatetimeRequired

Filter end datetime in UTC (ISO8601)

limitintegerOptional1-1000Defaults to 20
Max number of records to return
offsetintegerOptional>=0Defaults to 0
Number of records to skip
filter_conditionsstring or nullOptional

JSON array of filter conditions. Each condition has: id (string), field (from available fields), operator (equals/not_equals/includes/starts_with/ends_with for strings; equals/not_equals/greater_than/less_than for numbers), value. Example: [{“id”:“1”,“field”:“interaction_id”,“operator”:“equals”,“value”:“abc123”}]

Response

Successful Response
itemslist of objects
totalinteger
limitinteger
offsetinteger
next_page_uristring or null
prev_page_uristring or null

Errors

422
Unprocessable Entity Error