1Fetch Audit Logs
Overview
This API retrieves audit log entries filtered by date range and additional filter criteria.
Method: POST
Request URL: {kyvos-url}/rest/v2/activity-monitor/audit-logs
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies media type of request body. |
|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
fromDate | String | Start date for filtering audit logs. Format: MM/dd/yyyy. If not provided, defaults to the last 24 hours. If provided without toDate, toDate defaults to the current date. | – |
toDate | String | End date for filtering audit logs. Format: MM/dd/yyyy. Ignored if fromDate is not provided. If provided with fromDate, returns logs within the two dates. | – |
maxRows | String | Maximum number of audit log entries to return. Must be a valid integer. | Default: 300 |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
filterJson | String | JSON array of filter objects for advanced filtering. Each object contains fieldName, firstValue, and operation. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"auditLogs": [
{
"auditId": "17875526213764465764",
"sourceType": "User",
"action": "Sign-in",
"location": "Account",
"endTime": "08/24/2026 11:53:41 IST",
"source": "-",
"user": "kyvos.user",
"status": "Success"
},
{
"auditId": "17875526012077931756",
"sourceType": "User",
"action": "Sign-in",
"location": "Sales",
"endTime": "08/24/2026 11:53:21 IST",
"source": "-",
"user": "kyvos",
"status": "Success"
},
{
"auditId": "17875525298481764862",
"sourceType": "Workbook",
"action": "Update Entity",
"location": "Product",
"endTime": "08/24/2026 11:52:09 IST",
"source": "Workbook11",
"user": "kyvos",
"status": "Success"
},
{
"auditId": "17875525298308547958",
"sourceType": "Worksheet",
"action": "Update Entity",
"location": "Product Date",
"endTime": "08/24/2026 11:52:09 IST",
"source": "show category wise sales",
"user": "kyvos",
"status": "Success"
},
{
"auditId": "17875524889414896567",
"sourceType": "Connection",
"action": "AI Interaction",
"location": "(Not available)",
"endTime": "08/24/2026 11:51:28 IST",
"source": "Azure-Embedding-API",
"user": "kyvos.admin",
"status": "Success"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error. |
Resources
Below is an example of JSON structure which can be used as a reference for the filterJson parameter in the request body.
[
{
"fieldName": "DATE_TIME_RANGE",
"operation": "EQUAL_TO",
"dataType": "DATE",
"firstValue": "MM/dd/yyyy"
},
{
"fieldName": "USER_ID",
"operation": "INLIST",
"dataType": "CHAR",
"firstValue": "'301198281'"
},
{
"fieldName": "ACTION",
"operation": "INLIST",
"dataType": "NUMBER",
"firstValue": "Full Data Process Complete"
},
{
"fieldName": "SOURCE_TYPE",
"operation": "INLIST",
"dataType": "NUMBER",
"firstValue": "Semantic Model"
},
{
"fieldName": "SOURCE_NAME",
"operation": "CONTAINSIGNORECASE",
"dataType": "CHAR",
"firstValue": "SModelName"
},
{
"fieldName": "STATUS",
"operation": "INLIST",
"dataType": "NUMBER",
"firstValue": "Success"
},
{
"fieldName": "INSTANCE_NAME",
"operation": "CONTAINSIGNORECASE",
"dataType": "CHAR",
"firstValue": "intelli"
},
{
"fieldName": "ELAPSED_TIME",
"operation": "GREATER_THAN",
"dataType": "NUMBER",
"firstValue": "100000"
}
]