Skip to navigation
REST APIAuditAudit Logs

Download audit logs

View as Markdown
Download audit logs as a file, based on query params filter

Authentication

AuthorizationBearer
Bearer authentication

Query parameters

file_typeenumOptionalDefaults to CSV
Allowed values:
startdatetimeRequired
Start date of time range to fetch data in ISO 8601 timestamp format.
enddatetimeRequired
End date of time range to fetch data in ISO 8601 timestamp format.
offsetintegerOptional
The offset of the first item returned in the collection.
numberOfSamplesintegerOptional0-100000Defaults to 20
Maximum number of records to include in the file. The hard cap is 100,000. Use the offset parameter to page through additional records.
filterBylist of stringsOptional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Response

File downloaded

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error