The Audit Log API allows authorized clients to retrieve system audit logs with detailed information about API requests, user activities, and system events in JSON format. This is essential for monitoring system usage, troubleshooting issues, and maintaining security compliance. Audit logs can also be viewed through the platform interface (Administration -> Audit Logs).
1. Getting an Access Token
To authenticate API requests, an access token must be obtained using the credentials of your registered application.
📄 For getting an access token, please refer to the official guide.
Important Note
The retrieved token must be included in the Authorization header as a Bearer token in all API requests.
2. Audit Logs API
Endpoint:
- Method: GET
- URL:
{{BaseUrl}}/api/external/audit-logs
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| SkipCount | integer | Number of records to skip for pagination |
| MaxCount | integer | Maximum number of records to return |
| StartDate | string | Start date for log query (in UTC) |
| EndDate | string | End date for log query (in UTC) |
| HttpStatusCode | integer | Filter by HTTP status code |
Date Range Constraint
The maximum time range between StartDate and EndDate is 3 months.
Responses
| Status Code | Description |
|---|---|
| 200 | OK – report found and returned in requested format successfully |
| 400 | Bad Request – invalid Date |
| 401 | Unauthorized – missing or invalid token |
| 403 | Forbidden – insufficient tenant permissions |
| 404 | Not Found – log not found |
| 500 | Internal server error |
2.1. Example Request & Response
Here's an example of a request:
curl --location '{{BaseUrl}}/api/external/audit-logs?StartDate=2025-11-30&EndDate=2025-12-30&MaxCount=100' \
--header 'Authorization: Bearer {{Token}}'
Here's an example of a response:
[
{
"httpStatusCode": 204,
"httpMethod": "DELETE",
"url": "/api/app/projects/00000000-0000-0000-0000-000000000000",
"clientIpAddress": "::ffff:00.000.0.0",
"userName": "admin",
"time": "2025-12-29T07:48:02.1818283Z",
"duration": 640,
"browserInfo": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/143.0.0.0 Safari/537.36",
"parameters": [
"{\"id\":\"00000000-0000-0000-0000-000000000000\"}",
"{\"id\":\"00000000-0000-0000-0000-000000000000\"}"
]
}
{
"httpStatusCode": 200,
"httpMethod": "PUT",
"url": "/api/app/flows/0000000-0000-0000-0000-000000000000",
"clientIpAddress": "::ffff:00.000.0.0",
"userName": "admin",
"time": "2025-12-29T07:47:40.4663778Z",
"duration": 31,
"browserInfo": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/143.0.0.0 Safari/537.36",
"parameters": [
"{\"id\":\"0000000-0000-0000-0000-000000000000\",\"input\":{\"projectVersionId\":\"0000000-0000-0000-0000-000000000000\",\"name\":\"Main\",\"json\":\"{\\"paletteVersion\\":\\"2.12\\",\\"class\\":\\"GraphLinksModel\\",\\"nodeCategoryProperty\\":\\"node\\",\\"linkFromPortIdProperty\\":\\"fromPort\\",\\"linkToPortIdProperty\\":\\"toPort\\",\\"nodeDataArray\\":[{\\"isValid\\":true,\\"typeId\\":\\"06908895-80e6-4836-8b79-9001564198ea\\",\\"category\\":\\"node\\",\\"channels\\":[],\\"name\\":\\"start\\",\\"displayName\\":\\"Start\\",\\"inputs\\":[],\\"inputRules\\":[{\\"name\\":\\"in\\",\\"portId\\":\\"in\\"}],\\"outputRules\\":[{\\"name\\":\\"out\\",\\"portId\\":\\"out\\"}],\\"outputs\\":[],\\"order\\":18,\\"description\\":\\"Description\\",\\"isActionNodeOnly\\":false,\\"isFlowNodeOnly\\":false,\\"hasResponseCode\\":false,\\"showChannels\\":false,\\"isObsolete\\":false,\\"isEnabled\\":true,\\"key\\":-10,\\"loc\\":\\"540.9093924453421 134.39151488901405\\"},{\\"isValid\\":true,\\"typeId\\":\\"db7456b2-2af2-4ce8-ab06-41386136daac\\",\\"category\\":\\"node\\",\\"channels\\":[],\\"name\\":\\"returnToStart\\",\\"displayName\\":\\"Return To Start\\",\\"inputs\\":[],\\"inputRules\\":[{\\"name\\":\\"in\\",\\"portId\\":\\"in\\"}],\\"outputRules\\":[{\\"name\\":\\"out\\",\\"portId\\":\\"out\\"}],\\"outputs\\":[],\\"order\\":23,\\"description\\":\\"A special end node which returns to start node automatically for Main Flow.\\",\\"isActionNodeOnly\\":false,\\"isFlowNodeOnly\\":false,\\"hasResponseCode\\":false,\\"showChannels\\":false,\\"isObsolete\\":false,\\"isEnabled\\":true,\\"key\\":-5,\\"loc\\":\\"547.402228336749 689.2181236678621\\"},{\\"isValid\\":false,\\"typeId\\":\\"8803b1fd-329a-47e9-8b1a-af51b8b66b9d\\",\\"category\\":\\"node\\",\\"channels\\":[],\\"name\\":\\"virtualAgent\\",\\"displayName\\":\\"Virtual Agent\\",\\"inputs\\":[{\\"typeId\\":\\"02b13fe8-9429-4924-a0cf-c0f8ec07829f\\",\\"name\\":\\"tryCount\\",\\"order\\":4,\\"isMandatory\\":false,\\"description\\":\\"tryCount\\",\\"value\\":\\"2\\",\\"placeholder\\":\\"\\",\\"action\\":\\"Standard\\",\\"type\\":\\"number\\",\\"step\\":0,\\"range\\":[1,10],\\"options\\":[],\\"tooltip\\":\\"\\",\\"col\\":12,\\"fieldType\\":\\"input\\",\\"extraProperties\\":\\"\\",\\"groupName\\":null},{\\"typeId\\":\\"0124a1a8-b143-4c6d-bb85-3d16ff7d481e\\",\\"name\\":\\"virtualAgent\\",\\"order\\":1,\\"isMandatory\\":true,\\"description\\":\\"virtualAgent\\",\\"value\\":\\"\\",\\"placeholder\\":\\"\\",\\"action\\":\\"Standard\\",\\"type\\":\\"text\\",\\"step\\":0,\\"range\\":[],\\"options\\":[\\"selcen-new-test-EN\\"],\\"tooltip\\":\\"\\",\\"col\\":12,\\"fieldType\\":\\"select\\",\\"extraProperties\\":\\"\\",\\"groupName\\":null},{\\"typeId\\":\\"ce7c8ad5-190e-4d25-acae-c4dfd19d86f4\\",\\"name\\":\\"utterance\\",\\"order\\":0,\\"isMandatory\\":false,\\"description\\":\\"utterance\\",\\"value\\":\\"{\\\\\\"ops\\\\\\": [
{\\\\\\"insert\\\\\\": {\\\\\\"mention\\\\\\": {\\\\\\"denotationChar\\\\\\":\\\\\\"\\\\\\",\\\\\\"key\\\\\\":\\\\\\"LastUserInput\\\\\\",\\\\\\"value\\\\\\":\\\\\\"LastUserInput\\\\\\",\\\\\\"type\\\\\\":\\\\\\"static\\\\\\"
]
}
}