Request a download order for raw audit log entries

Request

Creates a download order for raw audit log entries. For nonbusiness audit types, only supported file formats are allowed.

Note

By default, the number of rows that can be exported in a single audit log download order is 10,000. The maximum number is 500,000 rows. You can configure the maximum number in the Settings page. If this number is exceeded, use the timestamp from the last row in the exported file to create a new download order starting from this point. If you need to raise these limits, contact Sitecore Support.

Security

OAuth2

Bodyapplication/jsonrequired

The parameters for generating the download order for raw audit logs.

audit_typestring(AuditType)

Represents the type of audit event. IMPORTANT: Do not change the number of existing entries or their order because this will break compatibility with older versions.

Enum:"Trigger""Action""Scripting""Business""Raw""Edge""PublicLink""RawOperational""DataPackageExport""DataPackageImport"

formatstring(FileFormat)

Enum:"CSV""Json"

fromstring or null, (date-time)(NullableOfDateTime)

tostring or null, (date-time)(NullableOfDateTime)

filterobject or null(DictionaryOfStringAndIEnumerableOfObject)

rawstring or null(String)

fullTextstring or null(String)

logTypeArray of strings or null(String[])

curl -i -X POST \
  https://your-server/api/audit/raw/generate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "audit_type": "Trigger",
    "format": "CSV",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "filter": {
      "property1": [
        null
      ],
      "property2": [
        null
      ]
    },
    "raw": "string",
    "fullText": "string",
    "logType": [
      "string"
    ]
  }'

Responses

Accepted

Response

No content