Represents a ShareFile Report: a set of configuration data used to generate JSON data
Name | Type | Description |
AccountId | String | The Account ID associated with this Report |
Title | String | The name the Report will appear under in the Reporting UI |
ReportType | ReportType | Access, Activity, Storage, Messaging, BandwidthDetail, BandwidthSummary, EncryptedEmail, StorageSummary, AccessChange, SharesSend, or SharesRequest |
ObjectType | ReportObjectType | Account, Folder, or User |
ObjectId | String | If ObjectType is specified, this is the Id of the object to run the Report against |
DateOption | ReportDateOption | (For non-Access reports) Specific, Today, Yesterday, ThisWeek, LastWeek, ThisMonth, LastMonth, or Last30Days |
ActivityTypes | String | (For Activity reports) A comma-delimited list of Login, LoginFail, LoginLocked, Download, View, WatermarkDownload, Upload, ZipUpload, Item_Delete, Item_Edit, Move, Item_Restore, NewFolder, NewNote, NewLink, DLP_Scan_Accept, DLP_Scan_Reject, DLP_Share_Allow, DLP_Share_Deny, Item_Archive, TFA_Login, TFA_LoginFail, TFA_InvalidCode, LoginFail_OAuthTokenExpired |
StartDate | DateTime | If Specific is the DateOption, the beginning of the date range to report on |
EndDate | DateTime | If specific is the DateOption, the end of the data range to report on |
LastRunDate | DateTime | The last time this Report was run |
IsRecurring | Boolean | True if the Report should run regularly |
IsScheduled | Boolean | Should match IsRecurring |
IncludeSubFolders | Boolean | If the ObjectType selected is Folder, whether or not subfolders should be included in the Report |
SaveToFolder | Boolean | True if the result of this Report should be directly saved to a ShareFile folder |
SaveFormat | String | If SaveToFolder is true, the format the Report should be saved in |
SaveFolderId | String | If SaveToFolder is true, the Id of the folder the Report should be saved in |
SaveFolder | Item | The Item object representing the folder selected with SaveFolderId |
Creator | User | The creator of the report |
CreatorId | String | The user ID of the creator of the Report |
Records | List of ReportRecord | An expandable property that includes all the ReportRecord objects associated with this Report |
CreateDate | DateTime | When this Report was originally created |
Frequency | ReportRunFrequency | If this Report is scheduled and recurring, when the Report should be run again - Once, Daily, Weekly, or Monthly |
DayOfWeek | Int32 | If the Report is scheduled to run weekly, the day of the week to run on (Sunday is 0, Saturday is 6) |
DayOfMonth | Int32 | If the Report is scheduled to run monthly, the day of the month to run on |
EmailNotice | Boolean | If true, the Report will send an email when it finishes executing |
EmailToNotify | String | If EmailNotice is true, the email address to notify |
Filter | ReportFilter | Specifies the custom Filters specific to each type of Report |