Audit trail events

Returns audit trail events.

Overview

Use this method to get raw audit trail events for your employees.

📘

Note

  • Events are always sorted by ts in an descending order.
  • Мах number of events per request is 20000.

Response explained

The HTTP status 200 in response confirms availability of our API.

NameTypeOptionalDescription
tsStringNoDate/time.
clientIdStringNoKey.
activityStringNoEvent type.
subjectNameStringNoThe subject who has executed an action.
ipStringNoIP from which an event was detected.
userAgentStringYesuserAgent from which an event was detected.
xClientIdStringYesAPI / dashboard / SDK.
correlationIdStringNoInternal id for investigation nearby requests.
applicantIdStringYesAn applicant identifier.
externalUserIdStringYesAn applicant identifier on the client side.
imageIdStringYesA document identifier.
descriptionStringYesSome additional information.

Possible event types

NameDescription
subject:loggedIn:dashboard:successSuccessful login.
ubject:loggedIn:dashboard:failureFailed login.
ubject:loggedOut:dashboardLogout.
subject:loaded:applicantLoading an applicant.
subject:loaded:applicantListLoading an applicant list.
subject:exported:applicantCsvListDownloading list of applicants in csv format.
subject:downloaded:docImageDownloading a doc from an applicant.
subject:changed:applicantChanging an applicant.
Language
Authorization
Header
Click Try It! to start a request and see the response here!