Remote Bandwidth Snapshots

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

List Remote Bandwidth Snapshots

SDK Method

\Files\Model\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

try {
  $remote_bandwidth_snapshots = \Files\Model\RemoteBandwidthSnapshot::list();
  foreach ($remote_bandwidth_snapshots as $remote_bandwidth_snapshot) {
    // Operate on $remote_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 RemoteBandwidthSnapshot Object

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

AttributeDescription
id
int64		Site bandwidth ID
sync_bytes_received
int64		Site sync bandwidth report bytes received
sync_bytes_sent
int64		Site sync bandwidth report bytes sent
logged_at
date-time		Time the site bandwidth report was logged
remote_server_id
int64		ID of related Remote Server