# Retrieve Client Configuration

Retrieve sounding clients and configurations.  Note: Multi-Link Operation (MLO) devices with Peer 2 will not be displayed.

Endpoint: GET /network/{network_id}/sounding/clients
Security: ApiKey

## Path parameters:

  - `network_id` (integer, required)
    The Network ID is a unique identifier that is assigned to a WiFi Motion network when it is created.  The Network ID is used by applications such as AppCloud, Device Manager, and via APIs, to uniquely identify a network.

## Response 200 fields (application/json):

  - `devices` (array)

  - `devices.device_id` (string)
    When is_node is true, this is the serial number of the AP.   When is_extender is true, this is the serialNumber of the extender device (or Masked-Mac if unavailable). 

 Nodes & Extenders only

  - `devices.device_info` (object)
    Device info record

  - `devices.device_info.device_type` (string)
    Human-readable identification string for this device

  - `devices.device_info.hostname` (string)
    Device hostname (if available)

  - `devices.device_info.mac` (string)
    Device MAC address

  - `devices.device_info.os` (string)
    Operating System

  - `devices.device_info.name` (string)
    Device name

  - `devices.device_info.category` (string)
    Device category

  - `devices.device_info.brand` (string)
    Brand name

  - `devices.device_info.model` (string)
    Model name

  - `devices.device_info.modelNumber` (string)
    Model number

  - `devices.device_info.ts` (number)
    Timestamp of last identification

  - `devices.friendly_name` (string)
    The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand.  For example, if referring to a location, it is easier for an end user to refer to a location as _Bedroom_ rather than the mac address of the device that is located in the bedroom.

  - `devices.id` (integer)
    If is_node is true, this value will be >0 and is the node_id of the AP.

 Nodes only

  - `devices.is_extender` (boolean)
    When is_node is true, indicates if this device is an extender (not full node).

  - `devices.is_node` (boolean)
    Indicates if the WiFi Motion software is running on the device.
- True: The WiFi Motion software is running on the device.
- False: The device is a wireless device only.

  - `devices.is_online` (boolean)
    true if the device is currently online

  - `devices.omot_version` (string,null)
    Algorithm version

  - `devices.is_root` (boolean)
    When is_node is true, indicates if this device is the root master.

 Nodes only

  - `devices.location` (string)
    Device location name.

  - `devices.sensitivity` (number)
    Below is a chart that provides a description of the different Sensitivity Levels that are available:

{% table %}

- Sensitivity Level {% width="15%" %}
- Description {% width="65%" %}
- Numerical Representation


---

- High
- Motion levels of all sizes will trigger detection.  Provides optimal coverage for most single family / detached dwellings.
- 1

---

- Medium
- Motion levels that are moderate or greater will trigger detection.  Provides optimal coverage for most dwellings that share one or more walls with a neighbor.
- 2

---

- Low
- Only motion levels that are large to intense will trigger detection.  Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting.
- 3

---

- Very Low 
- Only motion levels that are large to intense will trigger detection.  This setting is typically only used in scenarios such as a small accommodation with shared walls.  Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting.
- 7

---

{% /table %}

  - `devices.sensitivity_mode` (string)
    indicates whether the device is using the global sensitivity setting or is being overridden at the device level.
    Enum: "override", "global"

  - `devices.sounding_mode` (string)
    Indicates if this device can be used for sounding.

 Leafs & Extenders only
    Enum: "allow", "deny"

  - `devices.sounding_mesh` (string)
    Indicates if this device can be used for mesh link sounding.

If set to deny the Node in question will refuse mesh sounding connections

 Nodes only
    Enum: "allow", "deny"

  - `devices.mac` (string)
    This is the MAC address of the client device.

 Leafs & Extenders only

  - `devices.sounding_status` (boolean)
    Indicates if the device is currently actively sounding.

  - `devices.sounding_status_reason` (string)
    The reason code related to the selection choice determined by leafblower
    Enum: "N/A", "NO_DATA", "NOT_SOUNDED", "PASS", "NOT_PRESENT", "SLEEPING", "NOISY", "BROKEN"

  - `devices.sounding_status_score` (number)
    The last score that leafblower assigned to this device.

  - `devices.sounding_warmup` (boolean,null)
    Leafblower is currently determining the quality of the sounding state of the device.

Please note that the sounding_score is not considered stable until this is false.

  - `devices.links` (array)
    Low-level information on active sounding links

  - `devices.links.src_id` (integer)
    id of the node sounding this client

  - `devices.links.rssi` (string)
    Received Signal Strength Indicator, or RSSI, is the amount of power that was seen at the receiver of the wireless device, measured in dBm.  RSSI helps determine signal quality, troubleshoot connection problems, and is used in Wi-Fi and cellular systems to manage network performance and client roaming.

  - `devices.links.if_ch` (integer,null)
    WiFi Interface channel

  - `devices.sounding_history` (object,null)
    Object containing per-link historical sounding state

  - `devices.sounding_history.0` (integer)
    NOT_SOUNDED

  - `devices.sounding_history.1` (integer)
    PASS

  - `devices.sounding_history.2` (integer)
    NOT_PRESENT

  - `devices.sounding_history.3` (integer)
    SLEEPING

  - `devices.sounding_history.4` (integer)
    NOISY

  - `devices.sounding_history.5` (integer)
    BROKEN

  - `devices.sounding_history.-1` (integer)
    NO DATA

## Response 404 fields (application/json):

  - `error` (string)
    network not found
    Example: "something went wrong"


## Response 400 fields