Skip to main content
POST
Get Advisor Conversations
Retrieve conversations attended by a human agent to analyze response times, closure states, and assignments. You receive metadata about operators, users, and bots involved within a defined date range.

Endpoint


Authentication


Query Parameters


Request Body

Use bounded time windows to optimize the query and avoid overly wide ranges if you handle high volumes of conversations.

Request Examples


Responses


Response Detail

results object

pagination object


Performance metrics

Use the timeRepliedOperator and conversationDuration fields to analyze the efficiency of your support team:
  • timeRepliedOperator: Measures the time it takes an agent to give the first response (in milliseconds).
  • conversationDuration: Measures the total duration from the start to the close of the conversation (in milliseconds).

Authorizations

Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Query Parameters

limit
integer
default:10
page
integer
default:1

Body

application/json
startAt
string<date-time>
required
endAt
string<date-time>
required
getJson
boolean
required

Response

Conversations retrieved successfully

message
string[]
status
string
results
object[]
pagination
object