Retrieve audit logs

GET 
/api/v1/audit-logs

Retrieve audit logs

Request

Query Parameters

startTime date-time
endTime date-time
page int32
pageSize int32

Default value: 50

Responses

200

Successfully retrieved audit logs

application/json

Schema

Schema

logs object[]required
Array [
action stringrequired
Possible values: [CREATE, UPDATE, DELETE]
Type of action performed
actorIdentifier string
Readable identifier of the authenticated actor. This could an be OAuth user email, API key identifier, attributed webhook, etc.
ipAddress string
IP address of the actor
objectIdentifier stringrequired
Readable identifier of the object acted upon
objectType stringrequired
Type of object acted upon
timestamp date-timerequired
]
page int32required

Current page number, 0-indexed

totalPages int32required

Total number of pages

Example (from schema)

{
  "logs": [
    {
      "action": "CREATE",
      "actorIdentifier": "string",
      "ipAddress": "string",
      "objectIdentifier": "string",
      "objectType": "string",
      "timestamp": "2023-12-01T16:26:14.052Z"
    }
  ],
  "page": 0,
  "totalPages": 0
}

Loading...