---
title: "Wireless usage & capacity grid"
method: POST
path: "/dashboard/wireless/usage-capacity/grid"
tags: ["Dashboard Wireless Usage and Capacity"]
---

# Wireless usage & capacity grid

`POST /dashboard/wireless/usage-capacity/grid`

Returns the usage & capacity grid of wireless devices based on the provided filters. You can filter the results by sites.

## Query parameters

- `page` integer
- `limit` integer
- `keyword` string
- `sortField` 'HOSTNAME' | 'SITE' | 'RADIO_2DOT4G_UTILIZATION_SCORE' | 'RADIO_5G_UTILIZATION_SCORE' | 'RADIO_6G_UTILIZATION_SCORE' | 'WIFI0_RETRY_SCORE' | 'WIFI1_RETRY_SCORE' | 'WIFI2_RETRY_SCORE' | 'WIFI0_PACKET_LOSS' | 'WIFI1_PACKET_LOSS' | 'WIFI2_PACKET_LOSS' | 'ETH0_UNICAST_SCORE' | 'ETH0_BROADCAST_SCORE' | 'ETH0_MULTICAST_SCORE' | 'ETH1_UNICAST_SCORE' | 'ETH1_BROADCAST_SCORE' | 'ETH1_MULTICAST_SCORE' | 'WIFI0_INTERFERENCE_SCORE' | 'WIFI1_INTERFERENCE_SCORE' | 'WIFI2_INTERFERENCE_SCORE' | 'WIFI0_NOISE' | 'WIFI1_NOISE' | 'WIFI2_NOISE' | 'TOTAL_ETH0_SCORE' | 'TOTAL_ETH1_SCORE'
- `sortOrder` 'ASC' | 'DESC' — Sort Order
- `includeUnassigned` boolean

## Request body

- XiqUsageAndCapacityGridFilter — Request body for Usage and Capacity Filter
  - `site_ids` integer[] — List of site ids
  - `device_ids` integer[] — List of device ids
  - `building_ids` integer[] — List of building ids
  - `buildings` string[] — List of buildings
  - `floors` string[] — List of floors
  - `has_usage_capacity_issues` boolean — Flag to filter usage capacity issues
  - `number_filters` XiqNumberFilter[] — List of number filters
    - `column_name` string — The column name
    - `filter_type` 'GT' | 'GTE' | 'LT' | 'LTE' | 'EQ' | 'NEQ' | 'BTW' | 'BLANK' | 'NOT_BLANK' — The filter type
    - `value` integer — The value
    - `min` integer — The minimum value
    - `max` integer — The maximum value
  - `has_packet_loss_issues` boolean — Flag to filter packet loss issues
  - `has_retries_issues` boolean — Flag to filter retry issues

## Response `200`

OK

- PagedXiqUsageCapacityGridResponse
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqUsageCapacityGridResponse[] — The data in the current page
    - `hostname` string — Hostname of the device
    - `device_ip` string — The IP address of the device
    - `site` string — The site where the device is located
    - `building` string — The building where the device is located
    - `floor` string — The floor where the device is located
    - `mac_address` string — MAC address of the device
    - `wifi0_retry_score` integer — Retry score for wifi0
    - `wifi1_retry_score` integer — Retry score for wifi1
    - `wifi2_retry_score` integer — Retry score for wifi2
    - `wifi0_packet_loss` integer — Packet loss score in APs
    - `wifi1_packet_loss` integer — Packet loss score in APs
    - `wifi2_packet_loss` integer — Packet loss score in APs
    - `eth0_unicast_score` integer — Unicast score for Eth0 interface
    - `eth0_broadcast_score` integer — Broadcast score for Eth0 interface
    - `eth0_multicast_score` integer — Multicast score for Eth0 interface
    - `eth1_unicast_score` integer — Unicast score for Eth1 interface
    - `eth1_broadcast_score` integer — Broadcast score for Eth1 interface
    - `eth1_multicast_score` integer — Multicast score for Eth1 interface
    - `wifi0_interference_score` integer — Interference score for wifi0
    - `wifi1_interference_score` integer — Interference score for wifi1
    - `wifi2_interference_score` integer — Interference score for wifi2
    - `wifi0_noise` integer — Noise score for wifi0
    - `wifi1_noise` integer — Noise score for wifi1
    - `wifi2_noise` integer — Noise score for wifi2
    - `device_id` integer — The device id
    - `packet_loss` integer — The device id
    - `link_error2_dot4_g` integer — Link Error for wifi0
    - `link_error5g` integer — Link Error for wifi1
    - `link_error6g` integer — Link Error for wifi2
    - `healthy_clients` integer — The associated active client count for the device
    - `unhealthy_clients` integer — The associated inactive client count for the device
    - `has_usage_capacity_issue` boolean — Flag to indicate if device has usage capacity issue
    - `radio_2dot4g_utilization_score` integer — Channel Utilization score for 2.4 GHz radio
    - `radio_5g_utilization_score` integer — Channel Utilization score for 5 GHz radio
    - `radio_6g_utilization_score` integer — Channel Utilization score for 6 GHz radio

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)
