History Export Results

A HistoryExportResult is a single record with historical information about actions that happened in your site. Results can be obtained as a part of History Export request.

List History Export Results

SDK Method

files_sdk.history_export_result.list()

Return Object

ListObj[HistoryExportResult]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
history_export_id
int64
Required		ID of the associated history export.

Additional Arguments

Example Request

import files_sdk

try:
  history_export_results = files_sdk.history_export_result.list({
    "history_export_id": 1
  })
  for history_export_result in history_export_results.auto_paging_iter():
    # Operate on history_export_result
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The HistoryExportResult Object

Some of the methods above return a HistoryExportResult object. The attributes of this object are listed below.

AttributeDescription
id
int64		Action ID
created_at
int64		When the action happened
created_at_iso8601
string		When the action happened, in ISO8601 format.
user_id
int64		User ID
file_id
int64		File ID related to the action
parent_id
int64		ID of the parent folder
path
string		Path of the related action. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
folder
string		Folder in which the action occurred
src
string		File move originated from this path
destination
string		File moved to this destination folder
ip
string		Client IP that performed the action
username
string		Username of the user that performed the action
user_is_from_parent_site
boolean		true if this change was performed by a user on a parent site.
action
string		What action was taken. Valid values: create, read, update, destroy, move, login, failedlogin, copy, user_create, user_update, user_destroy, group_create, group_update, group_destroy, permission_create, permission_destroy, api_key_create, api_key_update, api_key_destroy, archived_delete
failure_type
string		The type of login failure, if applicable. Valid values: expired_trial, account_overdue, locked_out, ip_mismatch, password_mismatch, site_mismatch, username_not_found, none, no_ftp_permission, no_web_permission, no_directory, errno_enoent, no_sftp_permission, no_dav_permission, no_restapi_permission, key_mismatch, region_mismatch, expired_access, desktop_ip_mismatch, desktop_api_key_not_used_quickly_enough, disabled, country_mismatch, insecure_ftp, insecure_cipher, rate_limited
interface
string		Interface through which the action was taken. Valid values: web, ftp, robot, jsapi, webdesktopapi, sftp, dav, desktop, restapi, scim, office, mobile, as2, inbound_email, remote, inbound_s3
target_id
int64		ID of the object (such as Users, or API Keys) on which the action was taken
target_name
string		Name of the User, Group or other object with a name related to this action
target_permission
string		Permission level of the action
target_recursive
boolean		Whether or not the action was recursive
target_expires_at
int64		If searching for Histories about API keys, this is when the API key will expire. Represented as a Unix timestamp.
target_expires_at_iso8601
string		If searching for Histories about API keys, this is when the API key will expire. Represented in ISO8601 format.
target_permission_set
string		If searching for Histories about API keys, this represents the permission set of the associated API key
target_platform
string		If searching for Histories about API keys, this is the platform on which the action was taken
target_username
string		If searching for Histories about API keys, this is the username on which the action was taken
target_user_id
int64		If searching for Histories about API keys, this is the User ID on which the action was taken