Sign in
Audit Logs

Search Audit Logs

Returns audit events for the organization. Dates are interpreted in UTC. Request/response enums are aligned so values returned can be reused as filters.

post/v0/platform/audit-logs/search

Request body

start_datestring date-time required

Start of the date range (UTC, inclusive).

end_datestring date-time required

End of the date range (UTC, inclusive).

sort'asc' | 'desc'

Sort order for results by timestamp.

actor_typesAuditActorType[]

Filter results to events performed by these actor types.

actor_namesstring[]

Filter results to events performed by these actor names.

actionsAuditActionType[]

Filter results to these action types.

entity_typesAuditEntityType[]

Filter results to events affecting these entity types.

entity_idsstring[]

Filter results to events affecting these entity IDs.

chainsstring[]

Filter results to events associated with these chain names.

search_textstring

Free-text search across audit log fields.

pageinteger

Page number to return (1-indexed).

page_sizeinteger

Number of results per page.

Response

totalinteger required

Total number of matching audit log events.

pageinteger required

Current page number.

pagesinteger required

Total number of pages available.

sizeinteger required

Number of events returned in this page.

Changes

Changed in 3 of the 95 revisions of this API.114

  • 187d6a5259c61See the full diff
    • ○

      the endpoint scheme security JWT was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3debd2bfcd43112See the full diff
    • ▲

      removed the enum value api of the request property /

      request-property-enum-value-removed

    • ●

      added the new API enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new API enum value to the request property /

      request-property-enum-value-added

    • ○

      removed the api enum value from the // response property for the response status

      response-property-enum-value-removed

  • 4b1a9b2bf47d1See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 95 revisions, 1 has no diff computed.