Intents

Get most used intents

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)

after
string

Pagination cursor

before
string

Pagination cursor

first
integer <int64>

First x items. Used in combination with after

last
integer <int64>

Last x items. Used in combination with before

Responses
200

A successful response.

Response Schema: application/json
Array of objects (IntentInfo)
object (Pagination)
get/v1/bots/{bot_id}/intents
Request samples
Response samples
application/json
{
  • "data": [
    • {
      }
    ],
  • "pagination": {
    • "start_cursor": "string",
    • "end_cursor": "string",
    • "has_more": true
    }
}

Analytics_GetIntentInsights

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}/intents/insights
Request samples
Response samples
application/json
{
  • "data": {
    • "series": [
      ],
    • "series_labels": [
      ],
    • "x_values": [
      ]
    }
}