Query interactions and their messages based from the provided interaction start date.

Retrieves all interactions that started within a specified time range (up to a 7-day interval), filtered by the account ID contained in the JWT token. The result includes the interaction metadata and associated messages. Results are paginated using a cursor-based mechanism. The interaction_ended parameter refers to the end of the interaction start time range, not when the interaction itself ended. This endpoint only returns interactions that started between the interaction_started and interaction_ended timestamps.
The interactions in the time range can be narrowed down with the OData filter query parameter and sorted with order_by. For example, filter=queue in ('Billing','Support') and channel eq 'voice'&order_by=started_at:desc returns the voice interactions of the Billing and Support queues, most recent first. The filter and order_by parameters are sent with the first request (together with interaction_started and interaction_ended) and cannot be combined with cursor: the cursor returned in the response keeps the filter and the order of the first page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

interactions-public:read

Query Params
date-time
length ≥ 20

The start of the time range. Only interactions that started after or at this timestamp will be included.

date-time
length ≥ 20

The end of the time range. This refers to the end of the start time range — not when the interaction ended. Only interactions that started before or at this timestamp will be included.

string

The cursor to use for pagination. Cannot be used together with filter or order_by, the following pages keep the filter and the order of the first one. Cursors issued by a previous version of the API are not valid, restart the pagination from the first page.

string

An OData filter is applied on top of the time range; only interactions in the range that match the filter are returned. Filterable fields are id (interaction ID), queue, channel, and source_system. Supported operators are eq, ne, and in, combined with and, or, not, and parentheses. queue, channel and source_system can have several values per interaction, so eq matches when the interaction has the value and in when it has any of the values. Values are case-sensitive. A filter can reference at most 35 different queues and 50 different interaction IDs. Cannot be used together with cursor.

string
enum

Order of the interactions - started_at:asc (default) or started_at:desc. Cannot be used together with cursor.

Allowed:
Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/json