Activity Log Controller
Get activity logs with filters
Retrieve activity logs with optional filters by module, action, status, user, date range, etc.
get/activity-logs
Query parameters
toDatestring
Example:2024-12-31
fromDatestring
Example:2024-01-01
userEmailstring
Example:john@example.com
userIdstring
Example:1
action'CREATE' | 'UPDATE' | 'DELETE' | 'LOGIN' | 'LOGOUT' | 'VIEW' | 'PAYMENT_SUCCESS' | 'PAYMENT_FAILED' | 'PAYMENT_CANCELED' | 'PAYMENT_PROCESSING' | 'EMAIL_SENT' | 'DOCUMENT_VIEW' | 'DOCUMENT_DOWNLOAD' | 'OTHER'
modulestring
Example:orders
searchstring
Example:order created
sizenumber required
Example:10
pagenumber required
Response
Activity logs retrieved successfully
Example response
{
"totalItems": 100,
"items": [
{
"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"
}
],
"size": 10
}Changes
No recorded changes to this endpoint across all 1 revision of this API.