Conversations

Get conversation analytics

SecuritybasicAuth
Request
path Parameters
bot_id
required
string

Identifies the bot.

query Parameters
version
required
string

Identifies the bot version.

start_time
required
string

The starting date for the time range of the data series.

end_time
required
string

The ending date for the time range of the data series, exclusive.

channel_type
Array of strings

Filter by specific channels, multiple values separated by comma.

language
Array of strings

Filter by specific languages, multiple values separated by comma.

bucket
string

Time interval in which results will be grouped. Supported values are 1h,1d,1w. The interval should be smaller than the range specified in the [start_time,end_time)

group_by
string

Group by a specific category. Can be channel_type or language

Responses
200

A successful response.

Response Schema: application/json
object (SeriesData)
Array of objects (Serie)
series_labels
Array of strings
x_values
Array of strings
get/v1/bots/{bot_id}/conversations
Request samples 
Response samples 
application/json
{
  • "data": {
    • "series": [
      ],
    • "series_labels": [
      ],
    • "x_values": [
      ]
    }
}
Analytics_GetConversationsInsights
SecuritybasicAuth 
Request 
path Parameters
bot_id
required
string
Identifies the bot.


 
query Parameters
version
required
string
Identifies the bot version.


 
start_time
required
string
The starting date for the time range of the data series.


 
end_time
required
string
The ending date for the time range of the data series, exclusive.


 
stat
required
string
The stat to return, one of 'num_conversations', 'duration_seconds', 'num_messages'


 
channel_type
string
Filter by specific channels, multiple values separated by comma.


 
language
string
Filter by specific languages, multiple values separated by comma.


 
Responses 
200
A successful response.


Response Schema: application/json
object (SeriesData) 
 
Array of objects (Serie) 
 
series_labels
Array of strings
 
x_values
Array of strings
 
get/v1/bots/{bot_id}/conversations/insights
Request samples 
Response samples 
application/json
{
  • "data": {
    • "series": [
      ],
    • "series_labels": [
      ],
    • "x_values": [
      ]
    }
}
Analytics_GetConversationFlow
SecuritybasicAuth 
Request 
path Parameters
bot_id
required
string
Identifies the bot


 
conversation_id
required
string
Identifies the conversation


 
query Parameters
version
required
string
 
start_time
required
string
The starting date of the a range containing the conversation


 
end_time
required
string
The end date of the a range containing the conversation


 
message_id
string
Identifies a message withing a conversation. Optional.
When specified only the transitions for the given message will be included


 
Responses 
200
A successful response.


Response Schema: application/json
bot_id
string
 
conversation_id
string
 
user_id
string
 
Array of objects (FlowTransition) 
 
get/v1/bots/{bot_id}/conversations/{conversation_id}/flow
Request samples 
Response samples 
application/json
{
  • "bot_id": "string",
  • "conversation_id": "string",
  • "user_id": "string",
  • "transitions": [
    • {
      }
    ]
}
Analytics_GetTeamConversationsUsage
SecuritybasicAuth 
Request 
path Parameters
team_id
required
string
Identifies the team.


 
query Parameters
start_time
required
string
The starting date for the time range of the data series.


 
end_time
required
string
The ending date for the time range of the data series, exclusive.


 
bucket
required
string
Time interval in which results will be grouped.
Supported values are 1d, 1w, 1m. The interval should be smaller
than the range specified in the  [start_time,end_time).


 
group_by
string
Group data by field, comma separated. Can be any of [bot_id, bot_version, team_id, channel_type, language, campaign_id, campaign_source]


 
Responses 
200
A successful response.


Response Schema: application/json
object (SeriesData) 
 
Array of objects (Serie) 
 
series_labels
Array of strings
 
x_values
Array of strings
 
get/v1/teams/{team_id}/conversations
Request samples 
Response samples 
application/json
{
  • "data": {
    • "series": [
      ],
    • "series_labels": [
      ],
    • "x_values": [
      ]
    }
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.