---
title: "Wired client health grid"
method: POST
path: "/dashboard/wired/client-health/grid"
tags: ["Dashboard Wired Client Health"]
---

# Wired client health grid

`POST /dashboard/wired/client-health/grid`

Returns the client health grid of wired devices based on the provided filters. You can filter the results by sites.

## Query parameters

- `page` integer
- `limit` integer
- `keyword` string
- `sortField` 'UNSPECIFIED' | 'CONNECTION_STATUS' | 'CLIENT_HOSTNAME' | 'SITE' | 'BUILDING' | 'FLOOR' | 'IPV4' | 'IPV6' | 'PORT_NUMBER' | 'PORT_NUMBER_SWITCH_NAME' | 'VLAN' | 'OPERATING_SYSTEM' | 'MAC' | 'USERNAME' | 'INSTANT_PORT_PROFILE' | 'TOTAL_CONGESTION' | 'TOTAL_UNICAST' | 'TOTAL_MULTICAST' | 'TOTAL_BROADCAST' | 'TOTAL_PORT_ERRORS'
- `sortOrder` 'ASC' | 'DESC' — Sort Order

## Request body

- XiqWiredClientHealthGridRequest — Request body for Wired Client Grid
  - `site_ids` integer[] — The site ids
  - `device_ids` integer[] — The device ids
  - `filter_field` XiqWiredClientHealthFilter[] — The filters available for client health grid

## Response `200`

OK

- PagedXiqWiredClientHealthGridResponse
  - `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` XiqWiredClientHealthGridResponse[] — The data in the current page
    - `connection_status` 'CONNECTED' | 'DISCONNECTED' | 'UNKNOWN'
    - `client_hostname` string — The hostname of the client
    - `client_ip` string, ipv4 — The IP address of the client
    - `site` string — The site where the client is located
    - `building` string — The building where the client is located
    - `floor` string — The floor where the client is located
    - `ipv4` string, ipv4 — The IPv4 address assigned to the client
    - `ipv6` string, ipv6 — The IPv6 address assigned to the client
    - `port_number` string — The port number on which the device is connected
    - `switch_name` string — The switch name of the connected device
    - `vlan` integer — The VLAN
    - `operating_system` string — The operating system of the client device
    - `mac` string — The MAC address of the client device in format XXXXXXXXXXXX
    - `username` string — The username of the client
    - `instant_port_profile` string — The Instant Port Profile type assignment to client
    - `total_congestion_packets` integer — The total congestion packets
    - `total_unicast_packets_percentage` integer — The total unicast packets percentage
    - `total_multicast_packets_percentage` integer — The total multicast packets percentage
    - `total_broadcast_packets_percentage` integer — The total broadcast packets percentage
    - `total_port_errors` integer — The total port errors
    - `has_ip_address_issues` boolean — Indicates if there are IP address issues (related to UI tooltip)
    - `has_port_congestions` boolean — Indicates if there are port congestions (related to UI tooltip)
    - `has_traffic_anomalies` boolean — Indicates if there are traffic anomalies (related to UI tooltip)
    - `has_port_errors` boolean — Indicates if there are port errors (related to UI tooltip)
    - `device_id` integer — The device to which client is connected
    - `client_id` integer — The client ID
    - `is_ap_eth_client` boolean — Indicates if it is a AP eth connected client

---

[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)