{"id":24919,"date":"2020-10-31T08:43:33","date_gmt":"2020-10-31T08:43:33","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-1\/?p=24919"},"modified":"2021-03-18T11:41:35","modified_gmt":"2021-03-18T11:41:35","slug":"user-engagement-trend-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/api-guide\/user-engagement-trend-api\/","title":{"rendered":"User Engagement Trend API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To provide the number of users who have interacted with the bot in a given period across different time intervals.<\/p>\n

To use this API, the app needs the Bot Scope<\/em>.<\/p>\n

POST <\/b>https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/userEngagementTrend?aggregation_type={{type}}&start_date={{from}}&end_date={{to}}&channels={{channel}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Path Parameters<\/span><\/h3>\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
host<\/td>\nRequired<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
BotID<\/td>\nRequired<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n

 <\/p>\n\n\n\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
filters<\/td>\nRequired<\/td>\nObject with the following details to filter the result set<\/td>\n<\/tr>\n
start_date<\/td>\nRequired<\/td>\nRefers to the start time of the period to be considered.<\/td>\n<\/tr>\n
end_date<\/td>\nRequired<\/td>\nRefers to the end time of the period to be considered.<\/td>\n<\/tr>\n
channel<\/td>\nOptional<\/td>\nRefers to the channel from which the interactions have happened.<\/td>\n<\/tr>\n
aggregation_type<\/td>\nOptional<\/td>\nRefers to the type of aggregation to be allowed, possible values are:<\/p>\n
    \n
  • Hourly (Default)<\/li>\n
  • Daily<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Authorization<\/span><\/h3>\n

    Invoke the API with JWT in the header with the following syntax:<\/p>\n

    auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Response Content Type<\/span><\/h3>\n

    application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h3>\n
    curl -X POST \\\r\n  'https:\/\/{{host}}\/api\/public\/bot\/{{bot_id}}\/userEngagementTrend?aggregation_type=Hourly&start_date=2020-09-01&end_date=2020-09-05&channels=rtm '\\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h3>\n
      \n
    • when aggregation_type = Daily<\/strong>\n
      {\r\n  results:[\r\n     { date: \"MMM DD YYYY\",\r\n       users: \u201cnumber of users\u201d\r\n      },\r\n     { date: \"MMM DD YYYY\",\r\n       users: \u201cnumber of users\u201d\r\n      }\r\n     ],\r\n  totalResults: 2\r\n }<\/pre>\n<\/li>\n
    • when aggregation_type = Hourly or empty or not given<\/strong>\n
      {\r\n [\r\n   results:{\r\n       date:\"Aug 06 2020\",\r\n       \"0 - 1\": 20,\r\n       \"1 - 2\": 0,\r\n       \"2 - 3\": 0,\r\n       \"3 - 4\": 10,\r\n       \"4 - 5\": 0,\r\n       ..\r\n       \"23 - 0\": 0\r\n     },\r\n         {\r\n       date:\"Aug 07 2020\",\r\n       \"0 - 1\": 20,\r\n       \"1 - 2\": 0,\r\n       ..\r\n       \"21 - 22\": 0,\r\n       \"22 - 23\": 0,\r\n       \"23 - 0\": 0\r\n   }],\r\n  totalResults: 2\r\n }<\/pre>\n
       <\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
      <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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. 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...","protected":false},"author":14,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-24919","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/24919","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/users\/14"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/comments?post=24919"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/24919\/revisions"}],"predecessor-version":[{"id":24920,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/24919\/revisions\/24920"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/media?parent=24919"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/categories?post=24919"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/tags?post=24919"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}