Qodex.ai

List Event Types

GET {{baseUrl}}/logs/activitytypes

Return a list of queryable audit event types in the account of the API client.

Activity Types

The activityTypes object shows the accepted activity type query params that can be used in the Get Activity Log endpoint (see: List Events). The additionalFilters property shows what query parameters can be used for the specific activity type. The filters and displayOptions can be applied to any activity type.

There are several different types of audit events, and you can find an example collection in the result example below.

Log TypeUse
LoginsView regular, proxy, SSO, and Failed logins.
Password ChangesAny time a user changes their own password in the Account Settings page.
Password ResetsWhenever a password is reset. This includes users choosing Forgot Your Password? on the login page, Brand Admins sending password resets, or the user having to change their password because the password expired or you set new minimum requirements.
Session CreationsAny time an account is logged into, thus creating a new session. This is different from Logins because it doesn’t count failures or allow you to check for proxies. If you click a user, it will show when the session ended.
Session TerminationsEvery time a session terminates, either because a user logged out or an administrator forced them to. To see which, click the termination and look at the Reason field.
UsersAny time a user is created or deleted. Event Type will be Deleted for deleted users. Click a user for more information, such as their username before they were terminated.
API AccessView a user's API requests. You will find the transaction id for each call in the returned JSON.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"result":{"elements":[{"name":"logins","additionalFilters":["organizationId","userId"]},{"name":"session_creations","additionalFilters":["organizationId","userId"]},{"name":"session_terminations","additionalFilters":["organizationId","userId"]},{"name":"password_changes","additionalFilters":["organizationId","userId"]},{"name":"password_resets","additionalFilters":["organizationId","userId"]},{"name":"users","additionalFilters":["organizationId","userId"]},{"name":"brands","additionalFilters":["organizationId"]},{"name":"role_membership_change","additionalFilters":["organizationId"]},{"name":"role_permission_change","additionalFilters":["organizationId"]},{"name":"user_permission_change","additionalFilters":["organizationId","userId"]},{"name":"contact_list","additionalFilters":["organizationId","directoryId","groupId","userId"]},{"name":"contact","additionalFilters":["organizationId","directoryId","contactId","userId"]},{"name":"directory","additionalFilters":["organizationId","directoryId","userId"]},{"name":"directory_setting","additionalFilters":["organizationId","directoryId","userId"]},{"name":"dashboard_usage","additionalFilters":["organizationId","userId","dashboardId"]},{"name":"api_access","additionalFilters":["organizationId","userId"]}]},"meta":{"requestId":"8267c159-c9f5-4e92-a0f4-c53b5bb2d666","httpStatus":"200 - OK"}}