v1

latestOpenAPI 3.0.12026-08-0435481.5 MB
Audit logs

Get logs

Get logs that match the given query with pagination.

Pagination on large result sets

For tenants with very large log volumes, the default exact count(*) may exceed Postgres statement_timeout. Pass enableCap=true to short-circuit the count query: any tenant with more than 10,000 matching logs saturates Total-Number at the sentinel value 10001 and the response includes Total-Number-Is-Capped: true. In capped responses the Link header omits rel="last" and rel="next"; walk forward by incrementing page and stop on an empty response.

get/api/logs

Query parameters

userIdstring

Filter logs by user ID.

applicationIdstring

Filter logs by application ID.

logKeystring

Filter logs by log key.

enableCapstring

When true, short-circuits the underlying count(*) query: any tenant with more than 10,000 matching logs saturates Total-Number at the sentinel value 10001 and the response emits Total-Number-Is-Capped: true. The Link header then omits rel="last" and rel="next" because the real total is unknown. Default false; recommended true for any client whose tenant volume may exceed 10,000 matching logs to avoid statement_timeout.

start_timestring

Inclusive lower bound on createdAt, in unix milliseconds. When set, returns only logs where createdAt >= start_time. Recommended for clients paginating across very large log ranges to keep query latency consistent. Because the bound is inclusive, when resuming pagination from the last fetched log, pass its createdAt + 1 as start_time (or de-duplicate by log id) to avoid re-fetching the boundary log.

end_timestring

Inclusive upper bound on createdAt, in unix milliseconds. When set, returns only logs where createdAt <= end_time. Returns 400 if start_time > end_time when both are present.

pageinteger

Page number (starts from 1).

page_sizeinteger

Entries per page.

Response

An array of logs that match the given query.

tenantIdstring required
idstring required
keystring required
createdAtnumber required