@ctrl/nzbget
    Preparing search index...

    Interface NzbGetHistoryItem

    History item returned by history.

    interface NzbGetHistoryItem {
        Category: string;
        CriticalHealth?: number;
        Deleted?: boolean;
        DeleteStatus: NzbGetDeleteStatus;
        DestDir: string;
        DownloadedSizeHi?: number;
        DownloadedSizeLo?: number;
        DownloadedSizeMB?: number;
        DownloadTimeSec?: number;
        DupeKey?: string;
        DupeMode?: NzbGetDupeMode;
        DupeScore?: number;
        ExParStatus?: NzbGetExParStatus;
        ExtraParBlocks?: number;
        FailedArticles?: number;
        FileCount?: number;
        FileSizeHi: number;
        FileSizeLo: number;
        FileSizeMB?: number;
        FinalDir: string;
        Health?: number;
        HistoryTime?: number;
        ID: number;
        Kind?: NzbGetHistoryKind;
        Log?: NzbGetLogEntry[];
        MarkStatus: NzbGetMarkStatus;
        MaxPostTime?: number;
        MessageCount?: number;
        MinPostTime?: number;
        MoveStatus: NzbGetMoveStatus;
        Name: string;
        NZBFilename?: string;
        NZBID: number;
        NZBName?: string;
        NZBNicename?: string;
        Parameters: NzbGetParameter[];
        ParStatus: NzbGetParStatus;
        ParTimeSec?: number;
        PostTotalTimeSec?: number;
        RemainingFileCount?: number;
        RepairTimeSec?: number;
        RetryData?: boolean;
        ScriptStatus: NzbGetScriptStatus;
        ScriptStatuses?: NzbGetScriptStatusEntry[];
        ServerStats?: NzbGetServerStat[];
        Status: NzbGetHistoryStatus;
        SuccessArticles?: number;
        TotalArticles?: number;
        UnpackStatus: NzbGetUnpackStatus;
        UnpackTimeSec?: number;
        URL?: string;
        UrlStatus?: NzbGetUrlStatus;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    Category CriticalHealth? Deleted? DeleteStatus DestDir DownloadedSizeHi? DownloadedSizeLo? DownloadedSizeMB? DownloadTimeSec? DupeKey? DupeMode? DupeScore? ExParStatus? ExtraParBlocks? FailedArticles? FileCount? FileSizeHi FileSizeLo FileSizeMB? FinalDir Health? HistoryTime? ID Kind? Log? MarkStatus MaxPostTime? MessageCount? MinPostTime? MoveStatus Name NZBFilename? NZBID NZBName? NZBNicename? Parameters ParStatus ParTimeSec? PostTotalTimeSec? RemainingFileCount? RepairTimeSec? RetryData? ScriptStatus ScriptStatuses? ServerStats? Status SuccessArticles? TotalArticles? UnpackStatus UnpackTimeSec? URL? UrlStatus?
    Category: string

    Assigned category, or an empty string when none is set.

    CriticalHealth?: number

    Critical health threshold, in permille.

    Deleted?: boolean

    Since v12. Use DeleteStatus.

    DeleteStatus: NzbGetDeleteStatus

    Result of delete or cleanup handling.

    DestDir: string

    Destination directory for the item output.

    DownloadedSizeHi?: number

    Downloaded size, high 32 bits.

    DownloadedSizeLo?: number

    Downloaded size, low 32 bits.

    DownloadedSizeMB?: number

    Downloaded size in megabytes.

    DownloadTimeSec?: number

    Download time in seconds.

    DupeKey?: string

    Duplicate key.

    DupeMode?: NzbGetDupeMode

    Duplicate mode.

    DupeScore?: number

    Duplicate score.

    ExParStatus?: NzbGetExParStatus

    Duplicate par-scan repair status.

    ExtraParBlocks?: number

    Extra par blocks received from or donated to duplicates.

    FailedArticles?: number

    Number of failed article downloads.

    FileCount?: number

    Initial number of files in the group.

    FileSizeHi: number

    Total group size in bytes, high 32 bits.

    FileSizeLo: number

    Total group size in bytes, low 32 bits.

    FileSizeMB?: number

    Initial group size in megabytes.

    FinalDir: string

    Final destination directory if overridden during post-processing.

    Health?: number

    Final health of the group, in permille.

    HistoryTime?: number

    Time when the item was added to history, in Unix seconds.

    ID: number

    Since v13. Use NZBID.

    Kind?: NzbGetHistoryKind

    Kind of history item.

    Log?: NzbGetLogEntry[]

    Since v13. Always empty.

    MarkStatus: NzbGetMarkStatus

    Final mark assigned to the item.

    MaxPostTime?: number

    Newest article timestamp in Unix seconds.

    MessageCount?: number

    Number of messages stored in the item log.

    MinPostTime?: number

    Oldest article timestamp in Unix seconds.

    MoveStatus: NzbGetMoveStatus

    Result of moving the output to its destination.

    Name: string

    Friendly item name without path or extension.

    NZBFilename?: string

    Source nzb filename, possibly including a path.

    NZBID: number

    ID of the NZB entry.

    NZBName?: string

    Same as Name.

    NZBNicename?: string

    Since v12. Use NZBName.

    Parameters: NzbGetParameter[]

    Per-item parameters attached to the history entry.

    ParStatus: NzbGetParStatus

    Result of par-check or repair.

    ParTimeSec?: number

    Par-check time in seconds.

    PostTotalTimeSec?: number

    Total post-processing time in seconds.

    RemainingFileCount?: number

    Number of parked files in the group.

    RepairTimeSec?: number

    Repair time in seconds.

    RetryData?: boolean

    True if the item has completed files that can be retried (HistoryRetryFailed).

    ScriptStatus: NzbGetScriptStatus

    Result of post-processing scripts.

    ScriptStatuses?: NzbGetScriptStatusEntry[]

    Per-script results.

    ServerStats?: NzbGetServerStat[]

    Per-server article statistics.

    Status: NzbGetHistoryStatus

    Total status of the download, e.g. SUCCESS/ALL or FAILURE/FETCH.

    SuccessArticles?: number

    Number of successfully downloaded articles.

    TotalArticles?: number

    Total number of articles in the group.

    UnpackStatus: NzbGetUnpackStatus

    Result of unpacking.

    UnpackTimeSec?: number

    Unpack time in seconds.

    URL?: string

    URL for URL history items.

    UrlStatus?: NzbGetUrlStatus

    Result of URL-download.

    Settings
    Member Visibility

    On This Page
    Properties