Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get audit logs of entities

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

get/api_gateway/v2/audits

Query parameters

entityType'CUSTOMER' | 'CARD' required

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

entityIdinteger required

The unique identifier corresponding to the entity.

limitinteger

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

pageNointeger

The page number, indicating which page of results to retrieve

sortBystring

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

sortOrder'ASC' | 'DESC'

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

startDatestring date

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

endDatestring date

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

referenceType'Identifier' | 'StandardField' | 'ExtendedField' | 'CustomField' | 'CustomerStatus' | 'CardStatus' | 'SubscriptionStatus' | 'CustomerMerge' | 'CardCustomField' | 'CommChannel' | 'CardExtendedField'

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

referenceValuestring

The value for the selected reference type.

includeUserContextboolean

Enter true to retrieve user context details.

sourcestring

Entity source.

Response

200

Example response

{
  "data": [
    {
      "updatedBy": 75083604,
      "orgId": 100458,
      "entityType": "CUSTOMER",
      "entityId": 98662653,
      "createdOn": 1700733054030,
      "requestId": "25b7780ed479ce80cd95326bcd2a3d91",
      "source": "INSTORE",
      "updatedByMode": "API",
      "autoUpdateTime": 1700733053872,
      "events": [
        {
          "eventType": "Identifiers",
          "updatedField": "cardnumber",
          "additionalFields": {
            "previousValue": "NA",
            "currentValue": "DIWALI000000001620232"
          }
        }
      ]
    }
  ],
  "pagination": {
    "totalElements": 7,
    "totalPages": 1,
    "numberOfElements": 7
  }
}