Skip to main content
GET
/
v1
/
audit-events
List Audit Events
curl --request GET \
  --url https://tracer.lerian.io/v1/audit-events \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>'
{
  "auditEvents": [
    {
      "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "eventType": "TRANSACTION_VALIDATED",
      "resourceType": "transaction",
      "resourceId": "<string>",
      "action": "<string>",
      "result": "<string>",
      "actor": {
        "id": "<string>",
        "actorType": "user",
        "name": "<string>",
        "role": "<string>",
        "ipAddress": "<string>"
      },
      "context": {},
      "metadata": {},
      "hash": "<string>",
      "previousHash": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Headers

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-API-Key
string
required

The API Key for authentication. This header is required for all endpoints except health checks.

​
X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Query Parameters

​
limit
integer
default:100

The maximum number of items to include in the response. Default: 100, Max: 1000

Required range: 1 <= x <= 1000
​
cursor
string

Pagination cursor from previous response.

​
startDate
string<date-time>

Start date (RFC3339 format with timezone, inclusive). Defaults to 90 days before current time.

​
endDate
string<date-time>

End date (RFC3339 format with timezone, exclusive). Defaults to current time.

​
eventType
enum<string>

Filter by event type.

Available options:
TRANSACTION_VALIDATED,
RULE_CREATED,
RULE_UPDATED,
RULE_ACTIVATED,
RULE_DEACTIVATED,
RULE_DELETED,
LIMIT_CREATED,
LIMIT_UPDATED,
LIMIT_ACTIVATED,
LIMIT_DEACTIVATED,
LIMIT_DELETED
​
action
enum<string>

Filter by action.

Available options:
VALIDATE,
CREATE,
UPDATE,
DELETE,
ACTIVATE,
DEACTIVATE
​
result
enum<string>

Filter by result.

Available options:
SUCCESS,
FAILED,
ALLOW,
DENY,
REVIEW
​
resourceType
enum<string>

Filter by resource type.

Available options:
transaction,
rule,
limit
​
resourceId
string<uuid>

Filter by resource ID (UUID).

​
actorType
enum<string>

Filter by actor type.

Available options:
user,
system
​
actorId
string

Filter by actor ID.

​
accountId
string<uuid>

Filter by account ID (queries context.request.account.id).

​
segmentId
string<uuid>

Filter by segment ID.

​
portfolioId
string<uuid>

Filter by portfolio ID.

​
transactionType
string

Filter by transaction type.

​
matchedRuleId
string<uuid>

Filter by matched rule ID (array contains query).

​
sortBy
enum<string>
default:createdAt

The field used to sort the results.

Available options:
createdAt,
eventType
​
sortOrder
enum<string>
default:DESC

The order used to sort the results.

Available options:
ASC,
DESC

Response

Indicates that the request was successful and the response contains the expected data.

Paginated list of audit events for SOX/GLBA compliance.

​
auditEvents
object[]

List of audit event records.

Maximum array length: 1000
​
hasMore
boolean

Whether there are more results available.

​
nextCursor
string | null

Cursor for fetching the next page. Null if no more results.