Web API

Press shift + S to search API reference.

Object

Audit log

Endpoints that reference this object:

any of the below objects

A single "audit log task".

The keys common to all response types are id, createdByUserId, createdTime, timePeriod, filter


state
"pending" | "processing"

The audit log request has not started processing or is being processed. Check again in a few minutes.

id
string
createdByUserId
string

A user ID

createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

timePeriod
string

Either YYYY-MM or YYYY-MM-DD, as specified in the creation request.

filter
optional<string>

Filter specified in the creation request.


state
"error"

There was an error while attempting to process the audit log request. Refer to the error message and try again.

errorMessage
string

An error message explaining what went wrong while processing the request.

id
string
createdByUserId
string

A user ID

createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

timePeriod
string

Either YYYY-MM or YYYY-MM-DD, as specified in the creation request.

filter
optional<string>

Filter specified in the creation request.


state
"done"

The audit log request is done processing. Download the files in data.logFileUrls. The gzipped files contain newline-delimited JSON log entries.

data is uniquely provided with the done state

data
object

Results from the finished audit log processing.

expirationTime
string

The URLs in data.logFileUrls expire after 7 days.

logFileUrls
array of strings

URLs to audit log files.

id
string
createdByUserId
string

A user ID

createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

timePeriod
string

Either YYYY-MM or YYYY-MM-DD, as specified in the creation request.

filter
optional<string>

Filter specified in the creation request.