v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Dashboard Wired Usage and Capacity

Wired Usage and Capacity grid

Returns information related to usage and capacity for wired devices based on the provided filters. The result can be filtered by sites.

post/dashboard/wired/usage-capacity/grid

Query parameters

pageinteger

Page number, min = 1

limitinteger

Page Size, min = 1, max = 100

keywordstring

The keyword to search

sortField'UNSPECIFIED' | 'DEVICE_HOSTNAME' | 'DEVICE_IP' | 'SITE' | 'TOTAL_CLIENTS_COUNT' | 'TOTAL_ISSUE_CLIENTS_COUNT' | 'TOTAL_BANDWIDTH_UTILIZED' | 'TOTAL_THROUGHPUT_RX' | 'TOTAL_THROUGHPUT_TX' | 'TOTAL_UNICAST_PACKETS' | 'TOTAL_MULTICAST_PACKETS' | 'TOTAL_BROADCAST_PACKETS' | 'TOTAL_QUEUE_TX_PKTS' | 'TOTAL_QUEUE_CONGESTION_PKTS'

The field used for sorting

sortOrder'ASC' | 'DESC'

Sort Order

The sort order

Request body

site_idsinteger[]

List of site IDs to filter usage and capacity grid

device_idsinteger[]

List of device IDs to filter usage and capacity grid

filter_fieldXiqWiredUsageAndCapacityFilterType[]

The filters available for usage and capacity grid

Response

OK

pageinteger required

The current page number

countinteger required

The element count of the current page

total_pagesinteger required

The total page number based on request page size

total_countinteger required

The total element count