Get Admin Console Audit Logs API

To retrieve the audit logs from the Bot Admin Console.

Note

This feature was introduced in ver7.2 of the platform.

Method	GET
Endpoint	https://{{host}}/api/public/auditlogs? size=50&offset=0&fromDate={{timestamp}}&toDate={{timestamp}}&fetchAfter={{AuditLogId}}
Content Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
API Scope	Bot Builder: Not Applicable Admin Console: Logs > Admin Console Audit Logs

Path Parameters

PARAMETER	DESCRIPTION
host	Environment URL, for example, https://bots.kore.ai
size	Number of records to be fetched upto a maximum of 100
offset	Specify the page number from which to start fetching the logs. If unspecified, it starts from 0, which is the first page of the list of logs
fromDate	Takes the date format yyyy-mm-dd (or) yyyy-mm-ddThh:mm:ss.msZ eg:2019-04-01 (or) 2019-04-01T13:25:58.515Z
toDate	Takes the date format yyyy-mm-dd (or) yyyy-mm-ddThh:mm:ss.msZ eg:2019-04-01 (or) 2019-04-01 T13:26:05.598Z
fetchAfter (optional)	Audit Log Id from where you want to fetch the logs. This is an unique incremental ID for each record created under audit logs and you can obtain it from looking at the previous audit log file.

Sample Request

curl --location --request GET \
'https://{{host}}/api/public/auditlogs?size=50&offset=0&fromDate=2021-07-07T11:11:18.464Z&toDate=2021-06-30T11:11:18.469Z' \
--header 'auth: YOUR_JWT_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \

Sample Response

{
  "total": 3,
  "auditlogs": [
    {
      "timestampValue": 1578157612745,
      "Date/Time": "2020-01-04T17:06:52.745Z",
      "Description": "User logged out at Sat Jan 04 2020 22:36:52 GMT+0530(India Standard Time) from 127.0.0.1 via web",
      "Name": "Logout",
      "Category": "Login/Logout",
      "AuditLogId": "5e10c62ce0e2f05f0548048"
    },
    {
      "timestampValue": 1578157612773,
      "Date/Time": "2020-01-04T17:06:52.773Z",
      "Description": "User logged out at Sat Jan 04 2020 22:36:52 GMT+0530(India Standard Time) from 127.0.0.1 via web",
      "Name": "Logout",
      "Category": "Login/Logout",
      "AuditLogId": "5e10c62ce0e2f05f0548048"
    },
    {
      "timestampValue": 1578292105981,
      "Date/Time": "2020-01-06T06:28:25.981Z",
      "Description": "New app admin created",
      "Name": "App creation - Success",
      "Category": "Login/Logout",
      "AuditLogId": "5e10c62ce0e2f05f0548048"
    }
  ],
  "moreAvailable": false
}