Bandwidth Snapshots

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

List Bandwidth Snapshots

SDK Method

files_sdk.bandwidth_snapshot.list()

Return Object

ListObj[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 files_sdk

try:
  bandwidth_snapshots = files_sdk.bandwidth_snapshot.list()
  for bandwidth_snapshot in bandwidth_snapshots.auto_paging_iter():
    # Operate on bandwidth_snapshot
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The BandwidthSnapshot Object

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

AttributeDescription
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