# Network topology Endpoint: GET /network/{network_id}/topology Security: ApiKey ## Path parameters: - `network_id` (integer, required) Motion Network ID (returned as 'id' by Find API calls) ## Query parameters: - `offline` (boolean) When true, returns offline devices (they will have online=false in their device description). ## Response 200 fields (application/json): - `ts` (number) UTC timestamp report was produced - `devices` (array, required) Device list - `devices.id` (integer) Unique device identifier - `devices.name` (string) Device identifier - `devices.ip` (string) Device local IP - `devices.is_mesh_sounding` (boolean) Boolean if device is mesh sounding - `devices.friendly_name` (string) Device friendly name - `devices.node_name` (string) Name of AP this device is connected to - `devices.location` (string) Device location - `devices.type` (string) Enum: "MESH_ROOT", "MESH_NODE", "LEAF", "CLIENT" - `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.hw_platform` (string) Device hardware platform - `devices.macs` (array) List of MACs belonging to this device - `devices.icon` (string) Enum: "DEFAULT", "ORBI", "GWIFI", "NEST", "TPLINK", "LEAF" - `devices.online` (boolean) true if the device is currently online - `devices.mobile` (boolean) true if the device is presumed mobile - `devices.is_static` (string) Link fixed vs mobile detection state Enum: "UNKNOWN", "MOBILE", "STATIC_NEW", "STATIC" - `devices.tx_enable` (string) Keys are leaf macs, value is: "" - automatic sounding "1" - sounding forced enabled "0" - disabled - `devices.sounding_state` (string) Link sounding state Enum: "NONE", "ACTIVE", "SNEAKY" - `links` (array, required) Device interconnect - `links.src_id` (integer) Unique device identifier of link source - `links.dst_id` (integer) Unique device identifier of link destination - `links.motion_enabled` (boolean) - `links.detail` (object) - `links.detail.ip` (string) Local IP of link endpoint (from DHCP or ARP) - `links.detail.implicit_measurements` (string) Number of motion beacons on this link - `links.detail.serial_number` (string) - `links.detail.connected_time` (string) Connected time (sec) from ifconfig - `links.detail.max_rx_streams` (string) Maximum MIMO capability from motion80211 - `links.detail.uptime` (string) Connected time (ms) from motion80211 - `links.detail.motion_state` (string) Motion state from motion80211 - `links.detail.peer_type` (string) motion80211 peer_type - `links.detail.hostname` (string) Hostname of link endpoints (from DHCP) - `links.detail.sounding_candidates` (object) - `links.detail.motion_type` (string) Indicates what type of motion, if any, this link is capable of Enum: "MOTION_NONE", "MOTION_CSI", "MOTION_CV", "MOTION_CFR" - `links.detail.mac` (string,null, required) MAC in 00:11:22:33:44:55 format - `links.detail.last_heard` (string,null) Milliseconds elapsed since last communication on this link - `links.detail.if_name` (string, required) Interface name - `links.detail.if_index` (integer) Network interface index that the device is connected to. - `links.detail.is_mld` (boolean) Indicates whether or not the associated mac address is a Multi-Link Device. - : The device is a multi-link device. : The device is not a multi-link device. - `links.detail.if_mac` (string,null) MAC in 00:11:22:33:44:55 format - `links.detail.if_type` (string) Interface type Enum: "MESH", "WIFI_AP", "CLIENT", "UNKNOWN" - `links.detail.if_ch` (integer,null) Interface channel - `links.detail.wifi_protocol` (string, required) Wifi Protocol Level Enum: "WIRED", "802_11BG", "802_11N", "802_11AC", "802_11", "dhcp", "motion80211" - `links.detail.sounding_rate` (string) Motion beacon sounding period (ms) - `links.detail.node` (string) Device name of radar node this link is connected to - `links.detail.rssi` (any) Received Signal Strength on this link (dBm) from ifconfig - `links.detail.implicit_error_count` (string) Motion beacon error counter - `links.detail.mconf_zero_count` (integer) - `links.detail.phy` (string) - `links.detail.implicit_bw_downgrades` (string) - `links.detail.ht_capabilities` (string) (Deprecated) HT Capability Transmit Beamforming Capabilities 32-bit field as defined in IEEE802.11-2017 section 9.4.2.56.6 - `links.detail.vht_capabilities` (string) (Deprecated) VHT Capabilities information 32-bit field as defined in IEEE802.11-2017 section 9.4.2.158.2 - `links.detail.tx_bitrate` (string) TX Bitrate - `links.detail.tx_retries` (string) Number of TX retries from PHY - `links.detail.fw_rssi` (integer) Received Signal Strength on this link (dBm) from motion80211 - `links.detail.tx_failed` (string) Number of TX failures from PHY - `links.detail.rx_bitrate` (string) RX Bitrate - `links.detail.ifname` (string) Deprecated, use if_name. - `links.detail.aid` (string) Access point ID from motion80211 - `links.detail.tx_bytes` (any) TX Bytes sent - `links.detail.rx_bytes` (any) RX Bytes in - `links.detail.rssi_db` (string) Received Signal Strength on this link (dBm) from ifconfig - `links.detail.csi_report_count` (string) - `links.detail.v_matrix_report_count` (string) - `links.detail.cv_matrix_report_count` (string) - `links.detail.implicit_dsss` (string) - `links.detail.implicit_legacy_20` (string) - `links.detail.implicit_legacy_40` (string) - `links.detail.implicit_legacy_80_80` (string) - `links.detail.implicit_legacy_80` (string) - `links.detail.implicit_legacy_160` (string) - `links.detail.implicit_cck` (string) - `links.detail.dhcp_id` (string) - `links.detail.dhcp_expire` (string) - `links.detail.ht_supported` (string) - `links.detail.vht_supported` (string) - `links.detail.rate_ms` (string) - `links.detail.wifi_txpwr` (string)