Skip to main content
GET
Get Conversations Analytics

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Query Parameters

from_date
string<date-time> | null
to_date
string<date-time> | null
interval
enum<string>
Available options:
hour,
day,
week,
month,
year
timezone
string

IANA timezone identifier (e.g. America/New_York)

assistant_id
string
channel_id
enum<string>

ID of the connection integration

Available options:
internal,
org,
custom,
whatsapp_bot,
messenger_bot,
instagram_dm,
tiktok_dm,
telegram_bot,
gmail,
slack_bot,
twilio,
telnyx,
email,
smpp
agent_id
string

Response

200 - application/json

Conversations analytics for the specified organization.

Everything the Conversations analytics view renders, in one payload.

kpis
object
required
flow
object
required

Where conversations created in the period ended up. Unanswered handoffs are reported, never dropped.

conversations_by_channel
object[]
required
messages
object[]
required
messages_by_channel
object[]
required
messages_by_channel_series
object[]
required
resolution
object[]
required
handoff
object[]
required
csat
object[]
required
csat_distribution
object[]
required
takeover_distribution
object[]
required
resolution_distribution
object[]
required
team
object[]
required