Get audit logs of entities

get

https://{host}/api_gateway/v2/audits

This page provides you with information on entity audit log API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

entityType

string

enum

required

The type of entity for which you want to fetch audit logs.

Allowed:

entityId

int64

required

The unique identifier corresponding to the entity.

limit

int32

Defaults to 10

The number of results you wish to retrieve. Default value: 10.

pageNo

int32

Defaults to 0

The page number, indicating which page of results to retrieve

sortBy

string

Defaults to autoUpdateTime

The field by which results should be sorted. Default value: autoUpdateTime.

sortOrder

string

enum

The order in which results should be sorted. Supported values: ASC, DESC.

Allowed:

startDate

date

The start date of the date range. Example: 2022-08-18 16:00:00.

endDate

date

The end date of the date range. Example: 2022-08-18 16:00:00.

referenceType

string

enum

The reference type. For Extended fields and Custom fields, audit logging is allowed for a maximum of 5 fields each.

referenceValue

string

The value for the selected reference type.

includeUserContext

boolean

Enter true to retrieve user context details.

source

string

Entity source.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400