files.com
Version:
Files.com SDK for JavaScript
48 lines (38 loc) • 2.27 kB
Markdown
# BandwidthSnapshot
## Example BandwidthSnapshot Object
```
{
"id": 1,
"bytes_received": 1.0,
"bytes_sent": 1.0,
"sync_bytes_received": 1.0,
"sync_bytes_sent": 1.0,
"requests_get": 1.0,
"requests_put": 1.0,
"requests_other": 1.0,
"logged_at": "2000-01-01T01:00:00Z"
}
```
* `id` (int64): Site bandwidth ID
* `bytes_received` (double): Site bandwidth report bytes received
* `bytes_sent` (double): Site bandwidth report bytes sent
* `sync_bytes_received` (double): Site sync bandwidth report bytes received
* `sync_bytes_sent` (double): Site sync bandwidth report bytes sent
* `requests_get` (double): Site bandwidth report get requests
* `requests_put` (double): Site bandwidth report put requests
* `requests_other` (double): Site bandwidth report other requests
* `logged_at` (date-time): Time the site bandwidth report was logged
---
## List Bandwidth Snapshots
```
await BandwidthSnapshot.list
```
### Parameters
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `logged_at`.
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.