Audit Log

APIs for audit logs

Get Audits

post

Get audits by filter

Authorizations

AuthorizationstringRequired

Body

GenericStringDateFilter is a general filter that will fetch entities using the Query value and a date filter

fieldsstring[]Optional

filterobjectquerystringOptional

fromDatestring · date-timeOptional

fromDateLicensestring · date-timeOptional

ignoreWorkersbooleanOptional

Do not use workers mechanism while searching bleve

pageinteger · int64Optional

0-based page

querystringOptional

searchAfterstring[]Optional

Efficient next page, pass max sort value from previous page

searchAfterElasticstring[]Optional

Efficient next page, pass max ES sort value from previous page

searchBeforestring[]Optional

Efficient prev page, pass min sort value from next page

searchBeforeElasticstring[]Optional

Efficient prev page, pass min ES sort value from next page

sizeinteger · int64Optional

Size is limited to 1000, if not passed it defaults to 0, and no results will return

timeFrameinteger · int64Optional

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

toDatestring · date-timeOptional

trim_eventsinteger · int64Optional

Responses

200

auditResult

application/json

totalinteger · int64Optional

post/settings/audits

POST /settings/audits HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 710

{
  "Cache": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "accounts": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "fields": [
    "text"
  ],
  "filterobjectquery": "text",
  "fromDate": "2026-01-01T00:00:00.000Z",
  "fromDateLicense": "2026-01-01T00:00:00.000Z",
  "ignoreWorkers": true,
  "page": 1,
  "period": {
    "by": "text",
    "byFrom": "text",
    "byTo": "text",
    "field": "text",
    "fromValue": "text",
    "toValue": "text"
  },
  "query": "text",
  "searchAfter": [
    "text"
  ],
  "searchAfterElastic": [
    "text"
  ],
  "searchAfterMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "searchAfterMapOrder": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "searchBefore": [
    "text"
  ],
  "searchBeforeElastic": [
    "text"
  ],
  "size": 1,
  "sort": [
    {
      "asc": true,
      "field": "text",
      "fieldType": "text"
    }
  ],
  "timeFrame": 1,
  "toDate": "2026-01-01T00:00:00.000Z",
  "trim_events": 1
}

200

auditResult

{
  "audits": [
    {
      "action": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "cacheVersn": 1,
      "created": "2026-01-01T00:00:00.000Z",
      "highlight": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "id": "text",
      "identifier": "text",
      "indexName": "text",
      "modified": "2026-01-01T00:00:00.000Z",
      "numericId": 1,
      "object": "text",
      "primaryTerm": 1,
      "sequenceNumber": 1,
      "sizeInBytes": 1,
      "sortValues": [
        "text"
      ],
      "syncHash": "text",
      "type": "text",
      "user": "text",
      "version": 1
    }
  ],
  "total": 1
}