Sign in
Project API

Get the changes of an audited operation

Returns the fields that this operation changed on the addressed resource. The delta is derived from the audit log itself by comparing the stored representation with the one of the previous call to the same endpoint.

get/rest/api/v1/projects/{projectId}/auditLogs/{auditLogId}/changes

Path parameters

projectIdstring uuid required
auditLogIdstring required

Response

OK

actionstring

Trailing path segments for action endpoints

auditLogIdstring

Id of the audit log entry the delta was computed for

changeCountinteger

Number of changed fields

comparedToAuditLogIdstring

Id of the audit log entry the delta was computed against

comparedToTimestampstring date-time

Timestamp of the audit log entry the delta was computed against

diffAvailableboolean

True when a field level delta could be computed

diffUnavailableReason'NO_PREDECESSOR' | 'NO_PAYLOAD' | 'PAYLOAD_TRUNCATED' | 'PAYLOAD_NOT_JSON' | 'OPERATION_FAILED'

Why no delta is available

initialStateboolean

True when this entry is the oldest known state of the resource

operation'CREATE' | 'UPDATE' | 'DELETE' | 'ACTION'

Kind of operation

resourceIdstring

Id of the addressed resource, null for collection endpoints without a created id

resourceKeystring

URI prefix that collects the whole history of this resource

resourceTypestring

Type of the addressed resource

Example response

{
  "action": "actions/start",
  "ancestors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "project"
    }
  ],
  "auditLogId": "507f1f77bcf86cd799439011",
  "changeCount": 3,
  "changes": [
    {
      "after": "250",
      "before": "100",
      "field": "maxDailyLoss",
      "kind": "MODIFIED",
      "path": "riskLimits[2].maxDailyLoss",
      "valueType": "NUMBER"
    }
  ],
  "comparedToAuditLogId": "507f1f77bcf86cd799439010",
  "comparedToTimestamp": "2025-11-09T10:30:00Z",
  "diffAvailable": true,
  "diffUnavailableReason": "NO_PREDECESSOR",
  "operation": "UPDATE",
  "resourceId": "123e4567-e89b-12d3-a456-426614174001",
  "resourceKey": "/rest/api/v1/projects/123e4567-e89b-12d3-a456-426614174000/accounts/123e4567-e89b-12d3-a456-426614174001",
  "resourceType": "account"
}

Changes

Changed in 1 of the 8 revisions of this API.1