Bandwidth Snapshots

A BandwidthSnapshot is information about site bandwidth usage for the given date.

List Bandwidth Snapshots

SDK Function

BandwidthSnapshot.list()

Return Object

ListIterator<BandwidthSnapshot>

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 com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.BandwidthSnapshot;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<BandwidthSnapshot> bandwidthSnapshots = BandwidthSnapshot.list(parameters);
  for (BandwidthSnapshot bandwidthSnapshot : bandwidthSnapshots.listAutoPaging()) {
    // Operate on bandwidthSnapshot
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The BandwidthSnapshot Object

Some of the functions above return a BandwidthSnapshot object. The attributes of this object are listed below.

Attribute	Description
id int64	Site bandwidth ID
bytes_received int64	Site bandwidth report bytes received
bytes_sent int64	Site bandwidth report bytes sent
sync_bytes_received int64	Site sync bandwidth report bytes received
sync_bytes_sent int64	Site sync bandwidth report bytes sent
requests_get int64	Site bandwidth report get requests
requests_put int64	Site bandwidth report put requests
requests_other int64	Site bandwidth report other requests
logged_at date-time	Time the site bandwidth report was logged