Export User Activity Log

action=list

(Required)

user_action={value}

(Optional) You can filter the output based on the actions. For example, login (for user login), launch (for scan launched), finished (for scan finished), etc.

The actions which are included in the output depend on the user who runs the API. Managers see all actions taken by all users. Unit Managers see actions taken by users in their business unit. Scanners and Readers see their own actions only.

action_details={value}

(Optional) Filter on further information about the user actions. For example, for the action “error”, you can filter by the error details “No connection from scanner appliance”.

username={value}

(Optional) The name of the user who performed the action. Usernames are included in the output only if the user running the API is a Manager or a Unit Manager.

A Unit Manager can see usernames only for users in the Unit Manager’s hierarchy.

since_datetime={value}

(Optional) Specify the date to include the activity log starting from that point in time. Date must be in the format YYYY-MM-DD HH:ii:ss, and must be less than or equal to today’s date.

until_datetime={value}

(Optional) Specify the date to include the activity log until a specific point in time. Date must be in the format YYYY-MM-DD HH:ii:ss, and must be more than or equal to since_datetime, and less than or equal to today’s date.

user_role={value}

(Optional) A Manager or Unit Manager can choose to export logs for certain user roles instead of all user roles. Specify this parameter to export logs for users with certain user roles. Multiple roles are comma separated.

User roles you can specify: Manager, Unit Manager, Auditor, Scanner, Reader, KnowledgeBase Only, Remediation User, Contact

What logs are exported by default? For a Manager logs are exported for all users (all user roles) by default. For a Unit Manager logs are exported only for users (all user roles) in the Unit Manager’s hierarchy (i.e. business unit).

output_format=CSV

(Optional) CSV (default)

truncation_limit={value}

(Optional) Limit the number of log records to include in the CSV output.