v4

latestSwagger 2.02026-08-0343714211.7 MB

bandwidth_snapshots

Bandwidth Snapshots

List Bandwidth Snapshots

get/bandwidth_snapshots

Query parameters

cursorstring

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_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are logged_at.

If set, return records where the specified field is equal to the supplied value. Valid fields are logged_at.

If set, return records where the specified field is greater than the supplied value. Valid fields are logged_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are logged_at.

If set, return records where the specified field is less than the supplied value. Valid fields are logged_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are logged_at.

Response

A list of BandwidthSnapshots objects.

idinteger

Site bandwidth ID

bytes_receivedinteger

Site bandwidth report bytes received

bytes_sentinteger

Site bandwidth report bytes sent

sync_bytes_receivedinteger

Site sync bandwidth report bytes received

sync_bytes_sentinteger

Site sync bandwidth report bytes sent

requests_getinteger

Site bandwidth report get requests

requests_putinteger

Site bandwidth report put requests

requests_otherinteger

Site bandwidth report other requests

logged_atstring date-time

Time the site bandwidth report was logged

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"
  }
]