Skip to main content
GET
/
v1
/
monitoring
/
dashboard
/
throughput
Get Network Throughput
curl --request GET \
  --url https://api.altostrat.io/v1/monitoring/dashboard/throughput \
  --header 'Authorization: Bearer <token>'
[
  {
    "time_slot": "2025-10-29 10:00:00",
    "average_in_bps": 12500000.5,
    "average_out_bps": 2350000.75,
    "total_average_throughput_bps": 14850001.25
  }
]

Authorizations

โ€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

โ€‹
start_time
string<date-time>

The start of the time window in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Defaults to 4 hours ago.

Example:

"2025-10-29T08:00:00"

โ€‹
end_time
string<date-time>

The end of the time window in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Defaults to the current time.

Example:

"2025-10-29T12:00:00"

โ€‹
bucket_interval_minutes
integer
default:5

The time interval in minutes for aggregating data points.

Example:

15

โ€‹
site_ids[]
string<uuid>[]

An array of Site UUIDs to filter the results. If omitted, data from all accessible sites will be aggregated.

Response

A list of throughput data points aggregated into time buckets.

โ€‹
time_slot
string<date-time>

The start time of the aggregation bucket.

Example:

"2025-10-29 10:00:00"

โ€‹
average_in_bps
number

The average inbound throughput in bits per second for this time slot.

Example:

12500000.5

โ€‹
average_out_bps
number

The average outbound throughput in bits per second for this time slot.

Example:

2350000.75

โ€‹
total_average_throughput_bps
number

The combined average throughput in bits per second.

Example:

14850001.25