Retrieves an overview of the network.
GET/network/overview
This endpoint provides a summary of the network, including the total number of devices, their status distribution, and average performance metrics.
Responses
- 200 OK: Successfully retrieved the network overview.
- 500 Internal Server Error: Unexpected server error.
Request
Responses
- 200
- 500
Successfully retrieved the network overview.
- application/json
- Schema
- Example (from schema)
Schema
averageBandwidth
object
nullable
Represents bandwidth details for a network device
Download bandwidth in Mbps.
Upload bandwidth in Mbps.
The average network latency in milliseconds across all devices (optional).
The average packet loss percentage across all devices (optional).
deviceStatusCounts
object
required
A mapping of device statuses to their respective counts.
The total number of network devices in the system.
{
"averageBandwidth": {
"downloadMbps": 0,
"uploadMbps": 0
},
"averageLatencyMs": 0,
"averagePacketLossPercentage": 0,
"deviceStatusCounts": {},
"totalDevices": 0
}
Internal Server Error - Unexpected issue occurred.
- application/json
- Schema
- Example (from schema)
Schema
- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
- MOD7
- MOD8
- MOD9
- MOD10
- MOD11
- MOD12
- MOD13
- MOD14
- MOD15
- MOD16
oneOf
Possible values: [ClientError]
Possible values: [InternetConnectionError]
Possible values: [UnauthorizedError]
Possible values: [InternalServerError]
Possible values: [MissingDataError]
Possible values: [ParsingFailedError]
Possible values: [WritingDataError]
Possible values: [ForbiddenError]
Possible values: [NotAllowedError]
Possible values: [ValidationError]
Possible values: [SQLError]
Possible values: [StorageLimitExceededError]
Possible values: [StorageUnavailable]
Possible values: [ConflictError]
Possible values: [MatomoError]
Possible values: [ProcessInterrupted]
{}