Bandwidth Snapshots

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

List Bandwidth Snapshots

Endpoint

GET/bandwidth_snapshots

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

curl https://app.files.com/api/rest/v1/bandwidth_snapshots.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "bytes_received": 1,
    "bytes_sent": 1,
    "sync_bytes_received": 1,
    "sync_bytes_sent": 1,
    "requests_get": 1,
    "requests_put": 1,
    "requests_other": 1,
    "logged_at": "2000-01-01T01:00:00Z"
  }
]

The BandwidthSnapshot Object

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

Example BandwidthSnapshot Object

{
  "id": 1,
  "bytes_received": 1,
  "bytes_sent": 1,
  "sync_bytes_received": 1,
  "sync_bytes_sent": 1,
  "requests_get": 1,
  "requests_put": 1,
  "requests_other": 1,
  "logged_at": "2000-01-01T01:00:00Z"
}