KnowledgeBase

Analytics_GetKnowledgeBaseUsage

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
string

Filter by specific channels, multiple values separated by comma.

language
string

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)

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}/knowledge_base
Request samples 
Response samples 
application/json
{
  • "data": {
    • "series": [
      ],
    • "series_labels": [
      ],
    • "x_values": [
      ]
    }
}
Analytics_GetKnowledgeBaseTagsInsights
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
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
Array of objects (KnowledgeBaseTagInsight) 
 
 Array 
tag
string (Name of the tag) 
 
count
integer <int32>  (Total count of these tags) 
 
rank
integer <int32>  (Ordering position for this tag. Starts at 1) 
 
get/v1/bots/{bot_id}/knowledge_base/tags
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      }
    ]
}
Analytics_GetTeamKnowledgeBaseUsage
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).


 
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/teams/{team_id}/knowledge_base
Request samples 
Response samples 
application/json
{
  • "data": {
    • "series": [
      ],
    • "series_labels": [
      ],
    • "x_values": [
      ]
    }
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.