Audit Logs

Overview

The Audit Logs API provides a comprehensive tracking system for monitoring and retrieving historical changes made to various resources within the system. It captures detailed information about who made changes when they occurred, and what specific modifications were made.

Request Parameters

Parameter	Type	Required	Description
fromTimestamp	Long	Yes	Start time in Unix milliseconds (epoch)
toTimestamp	Long	Yes	End time in Unix milliseconds (epoch)
page	Integer	Yes	Page number (0-based indexing)
size	Integer	Yes	Number of records per page (default: 10)
... with more specific params

Response Structure

Response Fields

Field	Type	Description
list	Array	Array of audit log entries
totalRecords	Integer	Total number of records matching the query
totalPages	Integer	Total number of pages available

Audit Log Entry Fields

Field	Type	Description
requestTimestamp	Long	Timestamp of the action in Unix milliseconds
initiatorTenantName	String	Name of the tenant initiating the action
principalType	String	Type of principal ("API_KEY" or "USER")
principalId	String	API key ID (for API_KEY) or user ID (for USER)
principalName	String	API key ID (for API_KEY) or email address (for USER)
ipAddress	String	IP address of the requester
userAgent	String	User agent string of the requester
auditableAction	String	Type of action performed (e.g., "ASSIGN", "UNASSIGN")
auditableResource	String	Type of resource modified (e.g., "TRIGGER_VARIABLE", "SCHEME")
resourceName	String	Name of the specific resource
additionalMetadata	String	JSON string containing additional context
previousState	String	JSON string of the previous state
newState	String	JSON string of the new state

Additional Metadata Structure

The additionalMetadata field is a JSON string containing:

{
    "tenantName": "string",
    "endpointId": "long",
    "deviceSerialNumber": "string",
    "triggerCategoryName": "string",
    "targetLevel": "string",
    "targetLevelName": "string"
}

Example Response

{
    "list": [
        {
            "requestTimestamp": 1733315569000,
            "initiatorTenantName": "ExampleTenant",
            "principalType": "API_KEY",
            "principalId": "api-key-123",
            "principalName": "api-key-123",
            "ipAddress": "192.168.1.1",
            "userAgent": "Mozilla/5.0...",
            "auditableAction": "ASSIGN",
            "auditableResource": "TRIGGER_VARIABLE",
            "resourceName": "TriggerVariableA",
            "additionalMetadata": "{\"tenantName\":\"tenant name\",\"endpointId\":1,\"deviceSerialNumber\":\"something\",\"triggerCategoryName\":\"Tailgating\",\"targetLevel\":\"ENDPOINT\",\"targetLevelName\":\"1\"}",
            "previousState": "{\"value\":\"1.5\"}",
            "newState": "{\"value\":\"1.0\"}"
        }
    ],
    "totalRecords": 322,
    "totalPages": 161
}

Pagination

Use page parameter to specify the page number (0-based)
Use size parameter to specify the number of records per page
Total number of records and pages are included in the response
Calculate total pages: ⌈totalRecords ÷ size⌉