Remote Bandwidth Snapshots

A RemoteBandwidthSnapshot is a remote bandwidth report for the given date.

List Remote Bandwidth Snapshots

SDK Method

remotebandwidthsnapshot.List()

Return Object

[]*RemoteBandwidthSnapshot

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    remote_bandwidth_snapshot "github.com/Files-com/files-sdk-go/v3/remotebandwidthsnapshot"
)

remoteBandwidthSnapshotIterator, err := remote_bandwidth_snapshot.List(files_sdk.RemoteBandwidthSnapshotListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for remoteBandwidthSnapshotIterator.Next() {
    remoteBandwidthSnapshot := remoteBandwidthSnapshotIterator.remoteBandwidthSnapshot()
}
err = remoteBandwidthSnapshotIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

The RemoteBandwidthSnapshot Object

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

Attribute	Description
Id int64	Site bandwidth ID
SyncBytesReceived int64	Site sync bandwidth report bytes received
SyncBytesSent int64	Site sync bandwidth report bytes sent
LoggedAt date-time	Time the site bandwidth report was logged
RemoteServerId int64	ID of related Remote Server