Sign in
Activity Log Controller

Get activity log by ID

Get complete activity log details by ID

get/activity-logs/{id}

Path parameters

idnumber required

Response

idnumber required
titlestring required
descriptionstring
action'CREATE' | 'UPDATE' | 'DELETE' | 'LOGIN' | 'LOGOUT' | 'VIEW' | 'PAYMENT_SUCCESS' | 'PAYMENT_FAILED' | 'PAYMENT_CANCELED' | 'PAYMENT_PROCESSING' | 'EMAIL_SENT' | 'DOCUMENT_VIEW' | 'DOCUMENT_DOWNLOAD' | 'OTHER' required
modulestring required
userIdstring
userEmailstring
userNamestring
ipAddressstring
browserstring
locationstring
entityIdnumber
entityTypestring
paymentIdnumber
source'APPLICATION' | 'WEBSITE'
metadataobject
createdAtstring date-time required
errorMessagestring

Example response

{
  "id": 1,
  "title": "Order Created",
  "description": "User john@example.com created order #1234",
  "action": "CREATE",
  "module": "orders",
  "userId": "1",
  "userEmail": "john@example.com",
  "userName": "John Doe",
  "ipAddress": "192.168.1.1",
  "browser": "Chrome",
  "location": "New York, United States",
  "entityId": 1234,
  "entityType": "Order",
  "paymentId": 5678,
  "source": "APPLICATION",
  "metadata": {
    "browser": "Chrome",
    "browserVersion": "120.0",
    "os": "Windows",
    "osVersion": "10/11",
    "deviceType": "Desktop",
    "language": "en-US"
  },
  "createdAt": "2024-01-15T10:30:00.000Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.