Get Audit Events within a Time Window

GET 
/api/statistics/details/audit_events/

Retrieve or export audit events within a specified time window.

Request

Query Parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

start_date date-timerequired

Start of date range in format 'YYYY-MM-DDThh:mm:ss.sZ'

end_date date-timerequired

End of date range in format 'YYYY-MM-DDThh:mm:ss.sZ'

user integer[]

(optional) Filter by user id(s)

export string

Possible values: [csv]

Export the results in provided format. Supported formats are: csv

event_type stringrequired

Possible values: [ENTITY.COPY_RECURSIVE, ENTITY.REVISE, USER.LOGIN_FAIL, USER.DEV_PAIRING_RETRIEVE, WORKSPACE.CREATE, USER.DEV_PAIRING_VERIFY, WORKSPACE.ARCHIVE, APP.UPDATE_VARIABLES, APP.PUBLISH_FAIL, WORKSPACE.ENTER, APP.CREATE, WORKSPACE.CHANGE_VISIBILITY, WORKSPACE.DELETE_USERS, EDITOR.EXIT, ORG.INVITE_USERS, EDITOR.ENTER, USER.LOCK, USER.CLI_DOWNLOAD, WORKSPACE.INVITE_USERS, USER.LOGOUT, APP.UNARCHIVE, ENTITY.RENAME, EDITOR.COMPUTE, WORKSPACE.UNARCHIVE, ENTITY.SAVE, ENTITY.COPY, APP.UPDATE, ENTITY.DELETE, APP.PUBLISH, APP.ARCHIVE, USER.DEV_PAIRING_ACTIVATE, USER.SUBMIT_SUPPORT_TICKET, ORG.DELETE_USERS, ENTITY.CREATE, USER.LOGIN]

Type of the event. Supported types are: ENTITY.COPY_RECURSIVE, ENTITY.REVISE, USER.LOGIN_FAIL, USER.DEV_PAIRING_RETRIEVE, WORKSPACE.CREATE, USER.DEV_PAIRING_VERIFY, WORKSPACE.ARCHIVE, APP.UPDATE_VARIABLES, APP.PUBLISH_FAIL, WORKSPACE.ENTER, APP.CREATE, WORKSPACE.CHANGE_VISIBILITY, WORKSPACE.DELETE_USERS, EDITOR.EXIT, ORG.INVITE_USERS, EDITOR.ENTER, USER.LOCK, USER.CLI_DOWNLOAD, WORKSPACE.INVITE_USERS, USER.LOGOUT, APP.UNARCHIVE, ENTITY.RENAME, EDITOR.COMPUTE, WORKSPACE.UNARCHIVE, ENTITY.SAVE, ENTITY.COPY, APP.UPDATE, ENTITY.DELETE, APP.PUBLISH, APP.ARCHIVE, USER.DEV_PAIRING_ACTIVATE, USER.SUBMIT_SUPPORT_TICKET, ORG.DELETE_USERS, ENTITY.CREATE, USER.LOGIN

app integer[]

(optional) Filter by app(s)

workspace integer[]

(optional) Filter by workspace(s)

Responses

200

application/json

Schema

Schema

count integerrequired

Count of all the objects in the result set.

results

object[]

required

Array [

row_id string

Unique row id

context object

Event context

event_type string

Possible values: non-empty

timestamp date-time

user object

User details

]

Example (from schema)

{
  "count": 0,
  "results": [
    {
      "row_id": "string",
      "context": {},
      "event_type": "string",
      "timestamp": "2024-06-11T11:45:44.586Z",
      "user": {}
    }
  ]
}

400

Validation error response.

It produces a validation error schema like below.

{
    "field1": ["Validation error"],
    "non_field_errors": ["Sample non field validation error"]
}

401

No authentication found or authentication is not correct.

Loading...