{"id":61572,"date":"2024-03-29T11:26:34","date_gmt":"2024-03-29T11:26:34","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=61572"},"modified":"2024-03-29T12:06:05","modified_gmt":"2024-03-29T12:06:05","slug":"billing-usage-summary-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/billing-usage-summary-api\/","title":{"rendered":"Billing Usage Summary API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

This API provides a summary of the billing usage specific to an account or bot for a given period.<\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t\n\n\n\n\n\n\n
Method<\/strong><\/td>\nPOST and GET<\/span><\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nPOST
\nFor Bot Builder: https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/billingsessionsummary<\/code>
\nFor BAC: https:\/\/{{host}}\/api\/public\/billingsessionsummary<\/code> <\/p>\n

Important<\/b>: First, use the POST method to set filters, then use the following GET method to retrieve the billing session summary.<\/span><\/p>\n

GET
\nFor Bot Builder: https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/billingsessionsummary\/status?type=summary<\/code>
\nFor BAC: https:\/\/{{host}}\/api\/public\/billingsessionsummary\/status?type=summary<\/code><\/td>\n<\/tr>\n

Content Type<\/strong><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/strong><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token.<\/a><\/td>\n<\/tr>\n

API Scope<\/strong><\/td>\n\n
    \n
  • Bot Builder: Billing Sessions<\/li>\n
  • Bot Admin Console: Bot Analytics > Billing Sessions<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
    host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
    BotID<\/p>\n

    (when using with Bot Builder scope)<\/td>\n

    		Bot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/thead>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\n

    Sample POST Method Request for the Bot Builder API Scope<\/span><\/h3>\n
    curl --location 'https:\/\/{{HOST}}\/api\/public\/bot\/{{botId}}\/billingsessionsummary'\\\r\n--header 'auth: {{Auth Token}}' \\\r\n--header 'content-type: application\/json' \\\r\n--data-raw '{\r\n\"fromDate\": \"2023-04-07T10:10:54.680Z\",\r\n\"toDate\": \"2023-04-09T10:10:54.680Z\",\r\n\"unitType\": [\"request\",\"session\",\"alert\",\"proactive\",\"conversations\"],\r\n\"groupByBot\": \"no\",\r\n\"groupByPeriod\": \"date_day_hour\"\r\n},\r\n<\/code><\/pre>\n
    Note:<\/b> Use the POST method to set filters, then use the following GET method to retrieve the billing session summary:<\/p>\n
    Sample GET Method Request for the Bot Builder API Scope<\/span><\/h3>\n
    curl --location 'https:\/\/{{HOST}}\/api\/public\/bot\/{{botId}}\/billingsessionsummary\/statu?type=summary'\\\r\n--header 'auth: {{Auth Token}}' \\\r\n--header 'content-type: application\/json'\r\n<\/code><\/pre>\n
    Sample POST Method Request for the Admin API (BAC) scope<\/span><\/h3>\n
    curl --location 'https:\/\/{{HOST}}\/api\/public\/bots\/billingsessionsummary' \\\r\n--header 'auth: {{Auth Token}}' \\\r\n--header 'content-type: application\/json' \\\r\n--data-raw '{\r\n\"fromDate\": \"2022-09-01T07:18:54.089Z\",\r\n\"toDate\": \"2022-09-07T23:30:25.931Z\",\r\n\"unitType\": [\"session\",\"request\",\"alert\",\"proactive\", \u201cconversations\u201d],\r\n\"groupByBot\": \"yes\",\r\n\"streamIds\": [\"st-13d7a88d-83cb-52bb-b847-ed32cxxxxxxx\"],\r\n\"groupByPeriod\": \"date_month\"\r\n},\r\n<\/code><\/pre>\n
    Sample GET Method Request for the BAC API Scope<\/span><\/h3>\n
    curl --location 'https:\/\/{{HOST}}\/api\/public\/bots\/billingsessionsummary\/statu?type=summary'\\\r\n--header 'auth: {{Auth Token}}' \\\r\n--header 'content-type: application\/json'\r\n<\/code><\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Body Parameters for the POST Request<\/span><\/h2>\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired\/Optional<\/th>\nDescription<\/th>\n<\/tr>\n
    fromDate<\/td>\ndate, required<\/td>\nAccepts the date in yyyy-mm-dd format\u00a0(or) yyyy-mm-ddThh:mm:ss.msZ
    \nEg: 2019-04-01 (or) 2019-04-01T13:25:58.515Z<\/p>\n
    Default: no
    \nMax: 90 days<\/td>\n<\/tr>\n
    toDate<\/td>\ndate, required<\/td>\nAccepts the date in yyyy-mm-dd format
    \n(or) yyyy-mm-ddThh:mm:ss.msZ
    \nEg: 2019-04-01 (or) 2019-04-01T13:25:58.515Z<\/p>\n
    Default: no
    \nMax: 90 days<\/td>\n<\/tr>\n
    unitType<\/span><\/td>\nstring, required<\/span><\/td>\nThe unit type of the billing session.<\/span><\/p>\n
    Possible values:<\/span><\/p>\n
      \n
    • session – the conversation session<\/span><\/li>\n
    • request – the request that is sent to the bot<\/span><\/li>\n
    • alert – the alert notifications sent by the bot to users.<\/span><\/li>\n
    • proactive -the proactive notifications sent by the bot to the users.<\/span><\/li>\n
    • conversations – the conversations between the bot and a user.<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    groupByBot<\/span><\/td>\nstring, required<\/span><\/p>\n
      \n
    • Yes – If you want to use BAC scope with stream ID.<\/span><\/li>\n
    • No – If you want to use Bot Build scope without stream ID.<\/span><\/li>\n<\/ul>\n<\/td>\n
    		The parameter to group the billing sessions by bots<\/span><\/td>\n<\/tr>\n
    groupByPeriod<\/span><\/td>\nstring, required<\/span><\/td>\nThe parameter to retrieve the conversation sessions data on <\/span>Monthly<\/span><\/i>, <\/span>Daily, <\/span><\/i>and <\/span>Hourly <\/span><\/i>basis.<\/span><\/p>\n
    Possible values:<\/span>\u00a0<\/span><\/p>\n
      \n
    • date_day_hour\u00a0<\/span><\/li>\n
    • date_day<\/span><\/li>\n
    • date_month<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/thead>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
      <\/div>\r\n\t
      \r\n\t\t
      \r\n\t\t\t
      Sample Response<\/span><\/h2>\n
      Sample POST Method Response (BAC API Scope)<\/span><\/h3>\n
      \r\n{\r\n    \"reportId\": \"121242\",\r\n    \"status\": \"IN_PROGRESS\",\r\n    \"percentageComplete\": 0,\r\n    \"orgId\": \"o-d54e1923-94e5-5b33-b248-xxxxxxxx\",\r\n    \"createdBy\": \"u-093524cf-9df9-5371-b28b-xxxxxxxxx\",\r\n    \"jobType\": \"BILLINGSESSIONS_API\",\r\n    \"action\": \"QUERY\",\r\n    \"statusLogs\": [],\r\n    \"_id\": \"ds-d7d23763-b876-5219-b93e-6398ea4cb1ec\",\r\n    \"lMod\": \"2023-04-27T06:19:11.000Z\",\r\n    \"createdOn\": \"2023-04-27T06:19:11.034Z\",\r\n    \"__v\": 0\r\n}\r\n<\/code><\/pre>\n
      Sample GET Method Responses<\/span><\/h3>\n
      Monthly Billing Session Summary<\/b><\/p>\n
      \r\n{\r\n\"_id\": \"ds-df7dbe18-9028-59db-8d12-cda96xxxxxx\",\r\n\"status\": \"success\",\r\n\"__v\": 0,\r\n\"lastModifiedBy\": \"u-5c86a357-0346-5646-b143-007f6xxxxxx\",\r\n\"modifiedOn\": \"2023-04-24T09:46:37.668Z\",\r\n\"response\": {\r\n\"data\": [\r\n{\r\n\"bot\": \"ALL\",\r\n\"val\": [\r\n{\r\n\"date\": \"2023-04-01T00:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 57,\r\n\"proactive_notifications\": 10,\r\n\"conversations\": 3\r\n}\r\n}\r\n]\r\n}\r\n],\r\n\"averageSessions\": 70\r\n}\r\n}\r\n<\/code><\/pre>\n
      Daily Billing Session Summary<\/b><\/p>\n
      \r\n{\r\n\"_id\": \"ds-45b9f531-ac8b-5103-9a36-7960c3xxxxxxx\",\r\n\"status\": \"success\",\r\n\"__v\": 0,\r\n\"lastModifiedBy\": \"u-5c86a357-0346-5646-b143-007f6xxxxxxx\",\r\n\"modifiedOn\": \"2023-04-24T09:48:30.778Z\",\r\n\"response\": {\r\n\"data\": [\r\n{\r\n\"bot\": \"ALL\",\r\n\"val\": [\r\n{\r\n\"date\": \"2023-04-07T00:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 0,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-08T00:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 33,\r\n\"proactive_notifications\": 10,\r\n\"conversations\": 3\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-09T00:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 24,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n}\r\n]\r\n}\r\n],\r\n\"averageSessions\": 35\r\n}\r\n}\r\n<\/code><\/pre>\n
      Hourly Billing Session Summary<\/b><\/p>\n
      \r\n{\r\n\"_id\": \"ds-477c077e-605a-5253-8a66-a4678dxxxxx\",\r\n\"status\": \"success\",\r\n\"__v\": 0,\r\n\"lastModifiedBy\": \"u-5c86a357-0346-5646-b143-007f6xxxxxx\",\r\n\"modifiedOn\": \"2023-04-24T09:49:09.861Z\",\r\n\"response\": {\r\n\"data\": [\r\n{\r\n\"bot\": \"ALL\",\r\n\"val\": [\r\n{\r\n\"date\": \"2023-04-07T10:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 0,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n},\r\n},\r\n{\r\n\"date\": \"2023-04-08T10:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 2,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-08T15:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 2,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-08T16:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 4,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n\r\n{\r\n\"date\": \"2023-04-09T00:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 2,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-09T01:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 4,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n},\r\n},\r\n{\r\n\"date\": \"2023-04-09T05:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 2,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-09T06:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 2,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-09T07:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 2,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n{\r\n\"date\": \"2023-04-09T08:00:00.000Z\",\r\n\"val\": {\r\n\"requests\": 0,\r\n\"sessions\": 0,\r\n\"alert_notifications\": 4,\r\n\"proactive_notifications\": 0,\r\n\"conversations\": 0\r\n}\r\n},\r\n}\r\n],\r\n\"averageSessions\": 2\r\n}\r\n}\r\n<\/code><\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
      <\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"This API provides a summary of the billing usage specific to an account or bot for a given period. Method POST and GET Endpoint POST For Bot Builder: https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/billingsessionsummary For BAC: https:\/\/{{host}}\/api\/public\/billingsessionsummary  Important: First, use the POST method to set filters, then use the following GET method to retrieve the billing session summary. GET For...","protected":false},"author":26,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-61572","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/61572","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/26"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=61572"}],"version-history":[{"count":4,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/61572\/revisions"}],"predecessor-version":[{"id":61576,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/61572\/revisions\/61576"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=61572"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=61572"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=61572"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}