• ShareFile.Api.Models.Report
  • ShareFile.Api.Models.Report

    Represents a ShareFile Report: a set of configuration data used to generate JSON data

    NameTypeDescription
    AccountIdString The Account ID associated with this Report
    TitleString The name the Report will appear under in the Reporting UI
    ReportTypeReportType Access, Activity, Storage, Messaging, BandwidthDetail, BandwidthSummary, EncryptedEmail, StorageSummary, AccessChange, SharesSend, or SharesRequest
    ObjectTypeReportObjectType Account, Folder, or User
    ObjectIdString If ObjectType is specified, this is the Id of the object to run the Report against
    DateOptionReportDateOption (For non-Access reports) Specific, Today, Yesterday, ThisWeek, LastWeek, ThisMonth, LastMonth, or Last30Days
    ActivityTypesString (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
    StartDateDateTime If Specific is the DateOption, the beginning of the date range to report on
    EndDateDateTime If specific is the DateOption, the end of the data range to report on
    LastRunDateDateTime The last time this Report was run
    IsRecurringBoolean True if the Report should run regularly
    IsScheduledBoolean Should match IsRecurring
    IncludeSubFoldersBoolean If the ObjectType selected is Folder, whether or not subfolders should be included in the Report
    SaveToFolderBoolean True if the result of this Report should be directly saved to a ShareFile folder
    SaveFormatString If SaveToFolder is true, the format the Report should be saved in
    SaveFolderIdString If SaveToFolder is true, the Id of the folder the Report should be saved in
    SaveFolderItem The Item object representing the folder selected with SaveFolderId
    CreatorUser The creator of the report
    CreatorIdString The user ID of the creator of the Report
    RecordsList of ReportRecord An expandable property that includes all the ReportRecord objects associated with this Report
    CreateDateDateTime When this Report was originally created
    FrequencyReportRunFrequency If this Report is scheduled and recurring, when the Report should be run again - Once, Daily, Weekly, or Monthly
    DayOfWeekInt32 If the Report is scheduled to run weekly, the day of the week to run on (Sunday is 0, Saturday is 6)
    DayOfMonthInt32 If the Report is scheduled to run monthly, the day of the month to run on
    EmailNoticeBoolean If true, the Report will send an email when it finishes executing
    EmailToNotifyString If EmailNotice is true, the email address to notify
    FilterReportFilter Specifies the custom Filters specific to each type of Report