POST https://{{host}}/api/public/bot/{{BotID}}/userEngagementTrend?aggregation_type={{type}}&start_date={{from}}&end_date={{to}}&channels={{channel}}

Path Parameters

Parameter	Required/Optional	Description
host	Required	Environment URL, for example, https://bots.kore.ai
BotID	Required	Bot ID or Stream ID. You can access it from the General Settings page of the bot.

Query Parameters

Parameter	Required/Optional	Description
filters	Required	Object with the following details to filter the result set
start_date	Required	Refers to the start time of the period to be considered.
end_date	Required	Refers to the end time of the period to be considered.
channel	Optional	Refers to the channel from which the interactions have happened.
aggregation_type	Optional	Refers to the type of aggregation to be allowed, possible values are: Hourly (Default) Daily

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X POST \
  'https://{{host}}/api/public/bot/{{bot_id}}/userEngagementTrend?aggregation_type=Hourly&start_date=2020-09-01&end_date=2020-09-05&channels=rtm '\
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json'

Sample Response

when aggregation_type = Daily

{
  results:[
     { date: "MMM DD YYYY",
       users: “number of users”
      },
     { date: "MMM DD YYYY",
       users: “number of users”
      }
     ],
  totalResults: 2
 }

when aggregation_type = Hourly or empty or not given

{
 [
   results:{
       date:"Aug 06 2020",
       "0 - 1": 20,
       "1 - 2": 0,
       "2 - 3": 0,
       "3 - 4": 10,
       "4 - 5": 0,
       ..
       "23 - 0": 0
     },
         {
       date:"Aug 07 2020",
       "0 - 1": 20,
       "1 - 2": 0,
       ..
       "21 - 22": 0,
       "22 - 23": 0,
       "23 - 0": 0
   }],
  totalResults: 2
 }

On this Page

User Engagement Trend API

To provide the number of users who have interacted with the bot in a given period across different time intervals.

To use this API, the app needs the Bot Scope.