Activity Logs

get_activity_logs

Get list of activity logs for the authenticated user's organization

get_activity_logs

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_activity_logs",
    "arguments": {
        "page": 1,
        "limit": 10,
        "relations": [
          "createdBy"
        ],
        "entity": "USER",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "action": "CREATED",
        "actorType": "System",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "startDate": "2024-01-15T09:30:00Z",
        "endDate": "2024-01-15T09:30:00Z",
        "sortBy": "createdAt",
        "sortOrder": "DESC"
      }
  }
}

const result = await client.callTool({
  "name": "get_activity_logs",
  "arguments": {
    "page": 1,
    "limit": 10,
    "relations": [
      "createdBy"
    ],
    "entity": "USER",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "action": "CREATED",
    "actorType": "System",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "startDate": "2024-01-15T09:30:00Z",
    "endDate": "2024-01-15T09:30:00Z",
    "sortBy": "createdAt",
    "sortOrder": "DESC"
  }
});

result = await session.call_tool("get_activity_logs", arguments={
  "page": 1,
  "limit": 10,
  "relations": [
    "createdBy"
  ],
  "entity": "USER",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "action": "CREATED",
  "actorType": "System",
  "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "startDate": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "sortBy": "createdAt",
  "sortOrder": "DESC"
})

Parameters

pageinteger[1, 9007199254740991]1

Page number for pagination

limitinteger[1, 100]10

Number of items per page

relationsArray<string>createdByemployee

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Filter by entity type

entityIdstring<uuid>

Filter by entity ID

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

actorTypestringSystemUserAgent

Filter by actor type (System, User or Agent)

createdByUserIdstring<uuid>

Filter by user who performed the action

employeeIdstring<uuid>

Filter by employee context

startDatestring<date-time>

Filter logs from this date (ISO format)

endDatestring<date-time>

Filter logs until this date (ISO format)

sortBystringcreatedAtupdatedAtentityactioncreatedAt

Sort logs by field

sortOrderstringASCDESCDESC

Sort order

get_activity_log_count

Get activity log count in the authenticated user's organization

get_activity_log_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_activity_log_count",
    "arguments": {
        "entity": "USER",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "action": "CREATED",
        "actorType": "System",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_activity_log_count",
  "arguments": {
    "entity": "USER",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "action": "CREATED",
    "actorType": "System",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_activity_log_count", arguments={
  "entity": "USER",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "action": "CREATED",
  "actorType": "System",
  "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "startDate": "string",
  "endDate": "string"
})

Parameters

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Filter by entity type

entityIdstring<uuid>

Filter by entity ID

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

actorTypestringSystemUserAgent

Filter by actor type (System, User or Agent)

createdByUserIdstring<uuid>

Filter by user who performed the action

employeeIdstring<uuid>

Filter by employee context

startDatestring

Filter logs from this date (ISO format)

endDatestring

Filter logs until this date (ISO format)

get_activity_log

Get a specific activity log by ID

get_activity_log

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_activity_log",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_activity_log",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_activity_log", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The activity log ID

relationsArray<string>

Relations to include (e.g., ["createdBy", "employee"])

create_activity_log

Create a new activity log entry in the authenticated user's organization

create_activity_log

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_activity_log",
    "arguments": {
        "log_data": {
          "entity": "USER",
          "entityId": "550e8400-e29b-41d4-a716-446655440000",
          "action": "CREATED",
          "data": {},
          "previousValues": {},
          "updatedFields": [
            "string"
          ],
          "actorType": "System",
          "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
          "employeeId": "550e8400-e29b-41d4-a716-446655440000",
          "employee": {}
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_activity_log",
  "arguments": {
    "log_data": {
      "entity": "USER",
      "entityId": "550e8400-e29b-41d4-a716-446655440000",
      "action": "CREATED",
      "data": {},
      "previousValues": {},
      "updatedFields": [
        "string"
      ],
      "actorType": "System",
      "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "employeeId": "550e8400-e29b-41d4-a716-446655440000",
      "employee": {}
    }
  }
});

result = await session.call_tool("create_activity_log", arguments={
  "log_data": {
    "entity": "USER",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "action": "CREATED",
    "data": {},
    "previousValues": {},
    "updatedFields": [
      "string"
    ],
    "actorType": "System",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "employee": {}
  }
})

Request Body

{
  "log_data": {
    "entity": "USER",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "action": "CREATED",
    "data": {},
    "previousValues": {},
    "updatedFields": [
      "string"
    ],
    "actorType": "System",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "employee": {}
  }
}

Body

application/json

log_dataobjectrequired

The data for creating the activity log

Show child attributes

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATErequired

entityIdstring<uuid>required

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTEDrequired

dataobject

Show child attributes

[key: string]any

previousValuesobject

Show child attributes

[key: string]any

updatedFieldsArray<string>

actorTypestringSystemUserAgent

createdByUserIdstring<uuid>

employeeIdstring<uuid>

employeeobject

Show child attributes

[key: string]any

get_activity_logs_by_entity

Get activity logs for a specific entity

get_activity_logs_by_entity

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_activity_logs_by_entity",
    "arguments": {
        "entity": "USER",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "relations": [
          "createdBy"
        ],
        "action": "CREATED",
        "actorType": "System",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "startDate": "string",
        "endDate": "string",
        "sortBy": "createdAt",
        "sortOrder": "DESC"
      }
  }
}

const result = await client.callTool({
  "name": "get_activity_logs_by_entity",
  "arguments": {
    "entity": "USER",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "relations": [
      "createdBy"
    ],
    "action": "CREATED",
    "actorType": "System",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "startDate": "string",
    "endDate": "string",
    "sortBy": "createdAt",
    "sortOrder": "DESC"
  }
});

result = await session.call_tool("get_activity_logs_by_entity", arguments={
  "entity": "USER",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "relations": [
    "createdBy"
  ],
  "action": "CREATED",
  "actorType": "System",
  "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "startDate": "string",
  "endDate": "string",
  "sortBy": "createdAt",
  "sortOrder": "DESC"
})

Parameters

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATErequired

The entity type

entityIdstring<uuid>required

The entity ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

relationsArray<string>createdByemployee

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

actorTypestringSystemUserAgent

Filter by actor type (System, User or Agent)

createdByUserIdstring<uuid>

Filter by user who performed the action

employeeIdstring<uuid>

Filter by employee context

startDatestring

Filter logs from this date (ISO format)

endDatestring

Filter logs until this date (ISO format)

sortBystringcreatedAtupdatedAtentityactioncreatedAt

Sort logs by field

sortOrderstringASCDESCDESC

Sort order

get_activity_logs_by_user

Get activity logs created by a specific user

get_activity_logs_by_user

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_activity_logs_by_user",
    "arguments": {
        "userId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "entity": "USER",
        "action": "CREATED",
        "startDate": "string",
        "endDate": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_activity_logs_by_user",
  "arguments": {
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "entity": "USER",
    "action": "CREATED",
    "startDate": "string",
    "endDate": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_activity_logs_by_user", arguments={
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "entity": "USER",
  "action": "CREATED",
  "startDate": "string",
  "endDate": "string",
  "relations": [
    "string"
  ]
})

Parameters

userIdstring<uuid>required

The user ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Filter by entity type

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

startDatestring

Filter logs from this date (ISO format)

endDatestring

Filter logs until this date (ISO format)

relationsArray<string>

Relations to include

get_my_activity_logs

Get activity logs created by the current authenticated user

get_my_activity_logs

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_my_activity_logs",
    "arguments": {
        "page": 1,
        "limit": 10,
        "entity": "USER",
        "action": "CREATED",
        "startDate": "string",
        "endDate": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_my_activity_logs",
  "arguments": {
    "page": 1,
    "limit": 10,
    "entity": "USER",
    "action": "CREATED",
    "startDate": "string",
    "endDate": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_my_activity_logs", arguments={
  "page": 1,
  "limit": 10,
  "entity": "USER",
  "action": "CREATED",
  "startDate": "string",
  "endDate": "string",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Filter by entity type

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

startDatestring

Filter logs from this date (ISO format)

endDatestring

Filter logs until this date (ISO format)

relationsArray<string>

Relations to include

get_recent_activity_logs

Get recent activity logs for the authenticated user's organization

get_recent_activity_logs

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_recent_activity_logs",
    "arguments": {
        "limit": 20,
        "entity": "USER",
        "action": "CREATED",
        "hours": 24,
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_recent_activity_logs",
  "arguments": {
    "limit": 20,
    "entity": "USER",
    "action": "CREATED",
    "hours": 24,
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_recent_activity_logs", arguments={
  "limit": 20,
  "entity": "USER",
  "action": "CREATED",
  "hours": 24,
  "relations": [
    "string"
  ]
})

Parameters

limitnumber20

Maximum number of recent logs

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Filter by entity type

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

hoursnumber24

Get logs from the last N hours

relationsArray<string>

Relations to include

get_activity_log_statistics

Get activity log statistics for the authenticated user's organization

get_activity_log_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_activity_log_statistics",
    "arguments": {
        "startDate": "string",
        "endDate": "string",
        "entity": "USER",
        "action": "CREATED",
        "groupBy": "entity",
        "userId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_activity_log_statistics",
  "arguments": {
    "startDate": "string",
    "endDate": "string",
    "entity": "USER",
    "action": "CREATED",
    "groupBy": "entity",
    "userId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_activity_log_statistics", arguments={
  "startDate": "string",
  "endDate": "string",
  "entity": "USER",
  "action": "CREATED",
  "groupBy": "entity",
  "userId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Filter by entity type

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

groupBystringentityactionuserdatehourentity

Group statistics by

userIdstring<uuid>

Filter by specific user ID

delete_activity_logs

Delete activity logs based on criteria (for cleanup purposes)

delete_activity_logs

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_activity_logs",
    "arguments": {
        "olderThanDays": 0,
        "entity": "USER",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "action": "CREATED",
        "confirm": true
      }
  }
}

const result = await client.callTool({
  "name": "delete_activity_logs",
  "arguments": {
    "olderThanDays": 0,
    "entity": "USER",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "action": "CREATED",
    "confirm": true
  }
});

result = await session.call_tool("delete_activity_logs", arguments={
  "olderThanDays": 0,
  "entity": "USER",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "action": "CREATED",
  "confirm": true
})

Parameters

olderThanDaysnumber

Delete logs older than N days

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Delete logs for specific entity type

entityIdstring<uuid>

Delete logs for specific entity ID

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Delete logs for specific action type

confirmbooleanrequired

Confirmation flag - must be true to proceed with deletion

search_activity_logs

Search activity logs by metadata or data content

search_activity_logs

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_activity_logs",
    "arguments": {
        "query": "string",
        "limit": 20,
        "entity": "USER",
        "action": "CREATED",
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "search_activity_logs",
  "arguments": {
    "query": "string",
    "limit": 20,
    "entity": "USER",
    "action": "CREATED",
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("search_activity_logs", arguments={
  "query": "string",
  "limit": 20,
  "entity": "USER",
  "action": "CREATED",
  "startDate": "string",
  "endDate": "string"
})

Parameters

querystringrequired

Search query for data content

limitnumber20

Maximum number of results

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATE

Filter by entity type

actionstringCREATEDUPDATEDDELETEDVIEWEDASSIGNEDCOMPLETEDAPPROVEDREJECTED

Filter by action type

startDatestring

Filter logs from this date (ISO format)

endDatestring

Filter logs until this date (ISO format)

get_activity_timeline

Get activity timeline for a specific entity

get_activity_timeline

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_activity_timeline",
    "arguments": {
        "entity": "USER",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "limit": 50,
        "startDate": "string",
        "endDate": "string",
        "includeRelated": false
      }
  }
}

const result = await client.callTool({
  "name": "get_activity_timeline",
  "arguments": {
    "entity": "USER",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "limit": 50,
    "startDate": "string",
    "endDate": "string",
    "includeRelated": false
  }
});

result = await session.call_tool("get_activity_timeline", arguments={
  "entity": "USER",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "limit": 50,
  "startDate": "string",
  "endDate": "string",
  "includeRelated": false
})

Parameters

entitystringUSEREMPLOYEETASKPROJECTGOALINVOICEEXPENSEDEALCANDIDATErequired

The entity type

entityIdstring<uuid>required

The entity ID

limitnumber50

Maximum number of timeline entries

startDatestring

Timeline start date (ISO format)

endDatestring

Timeline end date (ISO format)

includeRelatedbooleanfalse

Include related entity activities

Stack Overflow Website Demo