Bandwidth Snapshots

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

List Bandwidth Snapshots

SDK Method

\Files\Model\BandwidthSnapshot::list;

Return Object

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

try {
  $bandwidth_snapshots = \Files\Model\BandwidthSnapshot::list();
  foreach ($bandwidth_snapshots as $bandwidth_snapshot) {
    // Operate on $bandwidth_snapshot
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The BandwidthSnapshot Object

Some of the methods 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