Zum Hauptinhalt springen

Activity Log Endpoints

Query activity logs and API call logs for auditing and debugging purposes.

Base Paths​

ResourcePath
Activity Logs/api/activity-log
API Call Logs/api/api-call-log

Activity Log Endpoints​

List Activity Logs​

GET /api/activity-log
Authorization: Bearer {token}

Query Parameters:

ParameterTypeDescription
entitystringFilter by entity type
entityIdstringFilter by entity ID
actionstringFilter by action type
actorTypestringFilter by actor type

Get Activity Log by ID​

GET /api/activity-log/:id
Authorization: Bearer {token}

API Call Log Endpoints​

List API Call Logs​

GET /api/api-call-log
Authorization: Bearer {token}

Create API Call Log​

POST /api/api-call-log
Authorization: Bearer {token}
Content-Type: application/json

{
  "url": "/api/tasks",
  "method": "GET",
  "statusCode": 200,
  "requestHeaders": "{}",
  "responseBody": "{}",
  "ipAddress": "127.0.0.1"
}

Action Types​

ActionDescription
CREATEDEntity was created
UPDATEDEntity was updated
DELETEDEntity was deleted

Actor Types​

Actor TypeDescription
UserHuman user action
SystemSystem/automated action

Data Model​

interface IActivityLog {
  id: string;
  entity: string;
  entityId: string;
  action: ActionTypeEnum;
  actorType?: ActorTypeEnum;
  description?: string;
  updatedFields?: string[];
  updatedValues?: Record<string, any>;
  previousValues?: Record<string, any>;

  // Relations
  creatorId?: string;
  organizationId: string;
  tenantId: string;
}

interface IApiCallLog {
  id: string;
  url: string;
  method: string;
  statusCode: number;
  requestHeaders?: string;
  requestBody?: string;
  responseBody?: string;
  ipAddress?: string;
  organizationId?: string;
  tenantId: string;
}