Audit Events

get
/audit-events/

This method returns details about an audit event, including the event's UUID, user information (email, name), timestamp, IP address, accessed URL, query parameters, post data, and request headers. Audit events are used to track user actions and system changes for security and compliance purposes.

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
content_typeintegerOptional

Query parameter content_type used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

object_idintegerOptional

Query parameter object_id used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

timestampstring · date-timeOptional

Query parameter timestamp used to filter results based on specific conditions.

timestamp__gtstring · date-timeOptional

Filters records where timestamp is greater than the given value.

timestamp__gtestring · date-timeOptional

Filters records where timestamp is greater than or equal to the given value.

timestamp__ltstring · date-timeOptional

Filters records where timestamp is less than the given value.

timestamp__ltestring · date-timeOptional

Filters records where timestamp is less than or equal to the given value.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

Responses
chevron-right
200

Successful response for status code 200.

application/json
countintegerOptional

Numerical value representing quantity or total amount.

Example: 123
nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4
previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2
get
/audit-events/
200

Successful response for status code 200.

get
/audit-events/{uuid}/

This method returns details about an audit event, including the event's UUID, user information (email, name), timestamp, IP address, accessed URL, query parameters, post data, and request headers. Audit events are used to track user actions and system changes for security and compliance purposes. This endpoint retrieves a specific record by its unique identifier.

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
uuidstring · uuidRequired

A UUID string identifying this Audit event.

Responses
chevron-right
200

Successful response for status code 200.

application/json
contentanyOptional

This field defines the content or details of the event, typically the data or change made.

content_typeintegerOptional

The classification or type related to this field.

headersany · nullableOptional

This field defines the HTTP headers sent along with the request, which can include metadata about the request.

object_idinteger · max: 2147483647Optional

This field defines the unique identifier of the object being affected by the event.

post_dataany · nullableOptional

This field defines the data sent by the client in the HTTP POST request.

query_paramsany · nullableOptional

This field defines the query parameters included in the URL during the request.

remote_addrstring · nullableOptional

This field defines the IP address of the client making the request.

timestampstring · date-timeOptional

This field defines the exact date and time when the event occurred.

urlstring · uri · max: 1000 · nullableOptional

This field defines the URL that the client accessed during the event.

uuidstring · uuidOptional

Unique identifier for the record.

get
/audit-events/{uuid}/
200

Successful response for status code 200.

Last updated

Was this helpful?