Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

User Activity Log API

Overview

User Activity Log API provides an audit trail of user actions performed within the Network Server.
It is designed for security, compliance, and operational transparency by tracking administrative and configuration changes across the system.


Key Capabilities

  • Tracking user actions (create, update, delete operations)
  • Filtering by user, time range, and event type
  • Pagination support for large audit datasets
  • Entity-level change tracking (devices, gateways, integrations)
  • Support for compliance and security auditing

Typical Use Cases

  • Security and compliance auditing (internal policies, ISO requirements)
  • Tracking configuration changes across network resources
  • Investigating “who changed what and when” scenarios
  • Monitoring user activity patterns in the system

How to GET User Activity Logs

/api/userActivityLog/?startTs={start_timestamp}&limit=15&page=0&endTs={end_timestamp}&sortField=ts&sortOrder=DESC
  • {startTs} = start timestamp
  • {endTs} = end timestamp

Additional request parameters:

  • {activity} = the activity that was done(CREATE/DELETE/UPDATE, etc.)
  • {customerId}= Customer ID
  • {customerTitle} = customer title/name
  • {description} = additional fieds
  • {entityId} = searching entity ID
  • {entityMetaId} = Entity UUID(e.g. Gateway ID/Device ID/Sub-Customer ID, etc.)
  • {entityMetaName} = Entity EUI(e.g. Gateway ID/Device EUI, etc.)
  • {entityType} = searching entity type (USER/CONVERTER/GATEWAY, etc.)
  • {userEmail} = the e-mail of the user who is taking the action
  • {userIpAddress} = the IpAddress of the user who is taking the action
  • {subCustomerTitle} = sub-customer name
  • {selectTotalCount} = return the total number of elements (boolean)

Request example with additional parameters:

https://{ns_or_oam_host}/api/userActivityLog/?
startTs=1707294966955&limit=15&page=0&customerTitle=test&subCustomerTitle=test&
entityType=APPLICATION&entityId=1111111111111a11111&entityMetaId=647FDA0000000&
userEmail=test@test.com&userIpAddress=0.0.0.0&activity=CREATE&endTs=1707381366955&sortField=ts&sortOrder=DESC