Test Result Schema
The test code indicates which test was run. You will receive data for tests with the following codes:
Agent Specific Codes
The schemas for these codes are described below.
Here are some helpful references for understanding the basics of the sensor test cycle and these tests:
Note Regarding Names and UIDs:
In the test result schemas below, sensor_name, network_name and service_name may change if an admin user changes the configuration in the UXI dashboard. However, the corresponding UIDs such as device_uid, network_uid and service (if applicable to the test) and customer_uid will not change.
Code: AP_SCAN
Periodic scan of the wireless environment.
Name |
| Type | Comments |
aps |
| list | List of BSSIDs from the scan |
| bssid | string | BSSID of the AP for this SSID |
| frequency | int | Channel frequency |
| rates | string | Supported rates |
| rssi | float | RSSI reported during the scan |
| security | string | SSID security |
| ssid | string | SSID name. Value may not always be present. |
| width | int | Channel width |
code |
| string | The test result code. Value will always be “AP_SCAN”. |
context |
| object | Object containing context of the test result |
| category | string | Category of the test result. Value will always be “wifi”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| interface_name | string | Interface name for the test result. Value is always “wlan0” |
| interface_type | string | Interface type for the test result. Value is always “wifi” |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. Will always be null |
| service_uid | string | UID of the service as defined in the dashboard. Will always be null |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example:
{
"aps": [
{
"bssid": "cc:d0:83:15:85:80",
"frequency": 2462,
"rates": "1.0 - 405.0 Mbps",
"rssi": -51.0,
"security": "wpa-psk",
"ssid": "ATM Demo - Psk",
"width": 20
},
{
"bssid": "20:a6:cd:36:b3:10",
"frequency": 5745,
"rates": "6.0 - 1733.3 Mbps",
"rssi": -53.0,
"security": "wpa-eap",
"ssid": "hpe",
"width": 80
},
{
"bssid": "20:a6:cd:36:be:30",
"frequency": 5500,
"rates": "6.0 - 1733.3 Mbps",
"rssi": -56.0,
"security": "wpa-eap",
"ssid": "hpe",
"width": 80
},
{
"bssid": "20:a6:cd:36:b3:90",
"frequency": 5745,
"rates": "6.0 - 1733.3 Mbps",
"rssi": -62.0,
"security": "wpa-eap",
"ssid": "hpe",
"width": 80
},
{
"bssid": "20:a6:cd:36:cf:d0",
"frequency": 5260,
"rates": "6.0 - 1733.3 Mbps",
"rssi": -67.0,
"security": "wpa-eap",
"ssid": "hpe",
"width": 80
},
{
"bssid": "cc:d0:83:15:85:90",
"frequency": 5180,
"rates": "6.0 - 1733.3 Mbps",
"rssi": -43.0,
"security": "wpa-psk",
"ssid": "ATM Demo - Psk",
"width": 80
}
],
"code": "AP_SCAN",
"context": {
"category": "wifi",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"hierarchy_node_name": "Office",
"hierarchy_node_path": "447ce3d76388.4930ce0d5ef0.dfef87578c2f.fe3f06c66732.2a2f593ea39a",
"interface_name": "wlan0",
"interface_type": "wifi",
"mac_address": "20:4c:03:36:4e:0d",
"network_name": "hpe",
"network_uid": "ssid-b4806328a465",
"operator": "eth0",
"sensor_name": "Main Lobby",
"sensor_serial": "ZAGRKLR02F",
"sensor_uid": "5ed42e51-a3f8-4620-a9ea-a6358829be3d",
"service_name": null,
"service_uid": null
},
"timestamp": "2022-05-07T19:04:07"
}
Code: AP_ASSOC
Sensor association time.
Name |
|
| Type | Comments |
code |
|
| string | The test result code. Value will always be “AP_ASSOC”. |
connect_time_milliseconds |
|
| float | Measured time to complete the association to the AP |
context |
|
| object | Dictionary containing context of the test result |
| category |
| string | Category of the test result. Value will always be “wifi”. |
| channel_utilisation |
| object | Channel utilization measured during association. (May not always be present ) |
|
| active | int | Channel active time (ms) |
|
| busy | int | Channel busy time (ms) |
|
| frequency | int | Channel frequency (MHz) |
|
| utilisation | float | Channel Utilization |
| customer_uid |
| string | Customer UID |
| hierarchy_node_name |
| string | The name of the group directly above the sensor. |
| hierarchy_node_path |
| string | dot delimited representation of the full sensor hierarchy |
| interface_name |
| string | Interface name for the test result. Value is always “wlan0” |
| interface_type |
| string | Interface type for the test result. Value is always “wifi” |
| mac_address |
| string | MAC address of the sensor |
| network_name |
| string | Alias of the network as defined in the dashboard |
| network_uid |
| string | UID of the network |
| operator |
| string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| qbss |
| object | Qbss report. Experimental/may not always be present |
|
| available_admission_capacity | int | Available admission capacity reported by qbss |
|
| channel_utilisation | float | Channel utilization reported by qbss |
|
| station_count | int | Station count reported by qbss |
| sensor_name |
| string | Name of the sensor as defined in the dashboard |
| sensor_serial |
| string | Serial number of the sensor |
| sensor_uid |
| string | UID of the sensor |
| service_name |
| string | Name of the service as defined in the dashboard. Will always be null |
| service_uid |
| string | UID of the service as defined in the dashboard. Will always be null |
| wifi_bssid |
| string | The BSSID of the AP the sensor is connected to for this test result. |
| wifi_channel |
| int | The channel the sensor is connected to for this test result. |
| wifi_frequency |
| float | The channel frequency the sensor is connected to for this test result. |
| wifi_signal_level |
| int | The RSSI measured by the sensor for this test result |
| wifi_ssid |
| string | The SSID the sensor is connected to for this test result. |
eap_time_seconds |
|
| float | EAP time during association. Only reported on networks with enterprise auth. |
timestamp |
|
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example
{
"code": "AP_ASSOC",
"connect_time_milliseconds": 262.36044,
"context": {
"category": "wifi",
"channel_utilisation": {
"active": 149,
"busy": 12,
"frequency": 5680,
"utilisation": 0.08053691
},
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"hierarchy_node_name": "Cambridge",
"hierarchy_node_path": "447ce3d76388.4930ce0d5ef0.dfef87578c2f.fe3f06c66732.2a2f593ea39a",
"interface_name": "wlan0",
"interface_type": "wifi",
"mac_address": "20:4c:03:36:4e:0d",
"network_name": "Cape",
"network_uid": "ssid-b4806328a465",
"operator": "eth0",
"qbss": {
"available_admission_capacity": 0,
"channel_utilisation": 0.118,
"station_count": 30
},
"sensor_name": "Harvard University",
"sensor_serial": "ZAGRKLR02F",
"sensor_uid": "5ed42e51-a3f8-4620-a9ea-a6358829be3d",
"service_name": null,
"service_uid": null,
"wifi_bssid": "58:b6:33:3e:03:cc",
"wifi_channel": 136,
"wifi_frequency": 5.68,
"wifi_signal_level": -38,
"wifi_ssid": "Cape"
},
"timestamp": "2022-05-07T19:04:15"
}
Code: WIFI_STATS
Periodic measurements of the wireless environment during the sensor test cycle.
Note that this test result does not always return values for all the fields below.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “WIFI_STATS”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “wifi”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| interface_name | string | Interface name for the test result. Value is always “wlan0” |
| interface_type | string | Interface type for the test result. Value is always “wifi” |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | UID of the network |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. Will always be null |
| service_uid | string | UID of the service as defined in the dashboard. Will always be null |
frequency |
| int | The channel frequency |
network_name |
| string | Alias of the network as defined in the dashboard |
overall_mcs |
| object | Modulation Coding Scheme. Will not always be present for every WIFI_STATS test result. |
| bandwidth | int | Channel bandwidth |
| datarate_bps | float | Data rate |
| datarate_type | string | Date rate type: Typically “HT” or “VHT” |
| guard_interval | string | Guard interval |
| index | int | MCS Index |
| mean_datarate_bps | float | Average data rate |
| spatial_streams | int | Spatial streams |
packets_deauthentication |
| int | Deauthentication packets observed |
packets_disassociation |
| int | Disassociation packets observed |
packets_retried |
| int | Retried packets observed |
packets_total |
| int | Total packets observed |
receive_mcs |
| object | Modulation Coding Scheme. Will not always be present for every WIFI_STATS test result. |
| bandwidth | int | Channel bandwidth |
| datarate_bps | float | Data rate |
| datarate_type | string | Date rate type: Typically HT or VHT |
| guard_interval | string | Guard interval |
| index | int | MCS Index |
| mean_datarate_bps | float | Average data rate |
| spatial_streams | int | Spatial streams |
retry_rate |
| float | Percentage of retried packets observed |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example:
{
"code": "WIFI_STATS",
"context": {
"category": "wifi",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"hierarchy_node_name": "Patient Lobby",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.6d7468f7536d.1356ea275c29",
"interface_name": "wlan0",
"interface_type": "wifi",
"mac_address": "20:4c:03:81:38:7f",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"sensor_name": "ER",
"sensor_serial": "CNJZKRY0C8",
"sensor_uid": "65aebeac-c43c-4242-8fdb-c22d6455a1a9",
"service_name": null,
"service_uid": "wifi_stats"
},
"frequency": 5180,
"overall_mcs": {
"bandwidth": 80,
"datarate_bps": 7270406700.0,
"datarate_type": "VHT",
"guard_interval": "short",
"index": 9,
"mean_datarate_bps": 850925380.0,
"spatial_streams": 2
},
"packets_deauthentication": 1,
"packets_disassociation": 0,
"packets_retried": 6,
"packets_total": 1014,
"receive_mcs": {
"bandwidth": 80,
"datarate_bps": 7270406700.0,
"datarate_type": "VHT",
"guard_interval": "short",
"index": 9,
"mean_datarate_bps": 850925380.0,
"spatial_streams": 2
},
"retry_rate": 0.00591716,
"timestamp": "2022-05-07T19:02:00"
}
Code: IEEE8021X_AUTH
A test measuring 802.1X authentication for wired networks. (For wireless see the AP Association test)
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “IEEE8021X_AUTH”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “ethernet”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is always “eth0” |
| interface_type | string | Interface type for the test result. Value is always “ethernet” |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | UID of the network |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. Will always be null |
| service_uid | string | UID of the service as defined in the dashboard. Will always be null |
connect_time_milliseconds |
| float | Time taken to connect to the network |
eap_time_seconds |
| float | Time taken to complete the EAP process |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Ethernet):
{
"code":"IEEE8021X_AUTH",
"context":{
"customer_uid":"d641ea5b-77df-4d60-9c18-ef6ce2a3606f",
"hierarchy_node_name": "Patient Lobby",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.6d7468f7536d.1356ea275c29",
"mac_address": "20:4c:03:81:38:7e",
"network_name": "Wired",
"network_uid": "ssid-fb1d500a62ff",
"ethernet_duplex_mode":"full",
"interface_name":"eth0",
"ethernet_link_speed_bps":100000000,
"interface_type":"ethernet",
"category":"ethernet",
"operator":"eth0",
"sensor_name": "ER",
"sensor_serial": "CNJZKRY0C8",
"sensor_uid": "65aebeac-c43c-4242-8fdb-c22d6455a1a9",
"service_name": null,
"service_uid": null
},
"connect_time_milliseconds":2428.113120025955,
"eap_time_seconds":0.41900000000000004,
"timestamp": "2022-05-07T19:02:00"
}
Code: DHCP
A test measuring DHCP response time.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “DHCP”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “network”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. Will always be null |
| service_uid | string | UID of the service as defined in the dashboard. Will always be null |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
dora_time_milliseconds |
| float | Full DHCP DORA time |
lease_time_milliseconds |
| float | DHCP lease time |
server |
| string | DHCP server |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "DHCP",
"context": {
"category": "network",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Patient Lobby",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.6d7468f7536d.1356ea275c29",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.140",
"mac_address": "20:4c:03:37:2b:8d",
"network_name": "Cape",
"network_uid": "ssid-b4806328a465",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"qbss": {
"available_admission_capacity": 0,
"channel_utilisation": 0.353,
"station_count": 8
},
"secondary_dns": "10.44.11.11",
"sensor_name": "Safe Patient Admissions",
"sensor_serial": "CNGPKLQ01P",
"sensor_uid": "83c7f688-54bf-43b7-8a70-d5602dd90ef9",
"service_name": null,
"service_uid": "dhcp",
"wifi_bssid": "58:b6:33:3e:03:c8",
"wifi_channel": 6,
"wifi_frequency": 2.437,
"wifi_signal_level": -28,
"wifi_ssid": "Cape"
},
"dora_time_milliseconds": 2207.2256,
"lease_time_milliseconds": 86400000,
"server": "10.12.6.1",
"timestamp": "2022-05-07T19:05:09"
}
Example (Ethernet):
{
"code": "DHCP",
"context": {
"category": "network",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "SoHo Penthouse",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.1229939f2df8",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.118",
"mac_address": "20:4c:03:34:a8:0c",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Apple Store",
"sensor_serial": "ZAGMKLR01J",
"sensor_uid": "7070ff29-4fef-47d4-9d89-fadad8528588",
"service_name": null,
"service_uid": "dhcp"
},
"dora_time_milliseconds": 2669.9695,
"lease_time_milliseconds": 86400000,
"server": "10.12.6.1",
"timestamp": "2022-05-07T19:12:39"
}
Code: DNS_RESOLVE
This test measures the time taken to resolve the DNS lookup domain.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “DNS_RESOLVE”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “network”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. Will always be null |
| service_uid | string | UID of the service as defined in the dashboard. Will always be null |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
resolve_time_milliseconds |
| float | Time taken to resolve the lookup domain |
target |
| string | The DNS server used to resolve the lookup domain. |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "DNS_RESOLVE",
"context": {
"category": "network",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Faculty Lounge",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.aca91eb89b5a.74f6d236ded9",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.144",
"mac_address": "20:4c:03:48:ba:a3",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "CTO's Office",
"sensor_serial": "CNH3KLQ094",
"sensor_uid": "5b3d9cf9-055e-462b-8006-5ba24ee6e799",
"service_name": null,
"service_uid": "dns",
"wifi_bssid": "cc:d0:83:15:85:90",
"wifi_channel": 36,
"wifi_frequency": 5.18,
"wifi_signal_level": -41,
"wifi_ssid": "ATM Demo - Psk"
},
"resolve_time_milliseconds": 296.0,
"target": "10.44.11.11",
"timestamp": "2022-05-07T19:13:14"
}
Example (Ethernet):
{
"code": "DNS_RESOLVE",
"context": {
"category": "network",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "SoHo Penthouse",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.1229939f2df8",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.118",
"mac_address": "20:4c:03:34:a8:0c",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Apple Store",
"sensor_serial": "ZAGMKLR01J",
"sensor_uid": "7070ff29-4fef-47d4-9d89-fadad8528588",
"service_name": null,
"service_uid": "dns"
},
"resolve_time_milliseconds": 294.0,
"target": "10.44.11.11",
"timestamp": "2022-05-07T19:12:49"
}
Code: DEFAULT_GATEWAY
This test checks the gateway is reachable. This test result does not have any metrics, but if you see this test result you know the gateway is reachable.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “DEFAULT_GATEWAY”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “network”. |
| customer_uid | string | Customer UID |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. Will always be null |
| service_uid | string | UID of the service as defined in the dashboard. Will always be null |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
target |
| string | The DNS server used to resolve the lookup domain. |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "DEFAULT_GATEWAY",
"context": {
"category": "network",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Faculty Lounge",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.aca91eb89b5a.74f6d236ded9",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.152",
"mac_address": "20:4c:03:34:83:8d",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "City Market",
"sensor_serial": "ZAGLKLR048",
"sensor_uid": "a7799899-fa09-4fbf-9dd6-8062b6737391",
"service_name": null,
"service_uid": "gateway",
"wifi_bssid": "cc:d0:83:15:85:90",
"wifi_channel": 36,
"wifi_frequency": 5.18,
"wifi_signal_level": -44,
"wifi_ssid": "ATM Demo - Psk"
},
"target": "10.12.6.1",
"timestamp": "2022-05-07T19:13:23"
}
Example (Ethernet):
{
"code": "DEFAULT_GATEWAY",
"context": {
"category": "network",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "Guest Services",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.6d7468f7536d.cdc9566a1e30",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.107",
"mac_address": "20:4c:03:34:82:cc",
"network_name": "Ethernet",
"network_uid": "ethernet-fbe769e02743",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "CEO's Office",
"sensor_serial": "ZAGLKLR045",
"sensor_uid": "12a6fc1f-d84d-4fbc-8153-3485b1c14cdd",
"service_name": null,
"service_uid": "gateway"
},
"target": "10.12.6.1",
"timestamp": "2022-05-07T19:13:18"
}
Code: CAPTIVE_PORTAL
This test runs a recorded captive portal script. If all the steps in the captive portal script complete successfully, you will get a captive portal load time.
Note: it’s possible for the test to not complete successfully, but complete enough steps to connect to the network. In this case you will not get a captive portal test result.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “CAPTIVE_POTAL”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “network”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID of the test result |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. Will always be null |
| service_uid | string | UID of the service as defined in the dashboard. Will always be null |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
load_time_milliseconds |
| float | Time taken to successfully complete all steps of the captive portal script |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "CAPTIVE_PORTAL",
"context": {
"category": "network",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Faculty Lounge",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.aca91eb89b5a.74f6d236ded9",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.152",
"mac_address": "20:4c:03:34:83:8d",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "City Market",
"sensor_serial": "ZAGLKLR048",
"sensor_uid": "a7799899-fa09-4fbf-9dd6-8062b6737391",
"service_name": null,
"service_uid": null,
"wifi_bssid": "cc:d0:83:15:85:90",
"wifi_channel": 36,
"wifi_frequency": 5.18,
"wifi_signal_level": -44,
"wifi_ssid": "ATM Demo - Psk"
},
"load_time_milliseconds": 3084.14576301584,
"timestamp": 1630991492.56796
}
Code: HTTP_GET
This test runs an HTTP GET for a provided target.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “HTTP_GET”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID of the test result |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
request_time_milliseconds
|
| float | Time taken to successfully complete the HTTP GET request
|
target |
| string | Target of the HTTP GET request |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi)
{
"code": "HTTP_GET",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "NY",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.6d7468f7536d.1356ea275c29",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.140",
"mac_address": "20:4c:03:37:2b:8d",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Admissions",
"sensor_serial": "CNGPKLQ01P",
"sensor_uid": "83c7f688-54bf-43b7-8a70-d5602dd90ef9",
"service_name": "AWS",
"service_uid": "-MqtjUVSTEPowCxWQi29",
"wifi_bssid": "cc:d0:83:15:85:90",
"wifi_channel": 36,
"wifi_frequency": 5.18,
"wifi_signal_level": -49,
"wifi_ssid": "ATM Demo - Psk"
},
"request_time_milliseconds": 1511.43,
"target": "http://console.aws.amazon.com:80",
"timestamp": "2022-05-07T19:13:17"
}
Example (Ethernet)
{
"code": "HTTP_GET",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "SoHo",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.1229939f2df8",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.118",
"mac_address": "20:4c:03:34:a8:0c",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Apple Store",
"sensor_serial": "ZAGMKLR01J",
"sensor_uid": "7070ff29-4fef-47d4-9d89-fadad8528588",
"service_name": "Check In",
"service_uid": "-MgmLnrAu8dOYubaXxD2"
},
"request_time_milliseconds": 1471.333,
"target": "https://www.apple.com:443",
"timestamp": "2022-05-07T19:13:15"
}
Code: PING
This test runs either an ICMP PING or a TCP PING for a specified target.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “PING”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID of the test result |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
jitter_milliseconds |
| float | Measured jitter in ms |
latency_max_milliseconds |
| float | Measured max latency in ms |
latency_milliseconds |
| float | Average latency in ms |
latency_min_milliseconds |
| float | Measured min latency in ms |
packets_dropped |
| int | Number of packets dropped |
packets_received |
| int | Number of packets received |
packets_sent |
| int | Number of packets sent |
protocol |
| string | Protocol: either "tcp" or "icmp" |
target |
| string | Target of the PING request |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi)
{
"code": "PING",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "SoHo",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.1229939f2df8",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.118",
"mac_address": "20:4c:03:34:a8:0c",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Apple Store",
"sensor_serial": "ZAGMKLR01J",
"sensor_uid": "7070ff29-4fef-47d4-9d89-fadad8528588",
"service_name": "AWS",
"service_uid": "-M2RIIk2HFZd8uEmwfJx"
},
"jitter_milliseconds": 1.6794707,
"latency_max_milliseconds": 282.7251,
"latency_milliseconds": 280.65115,
"latency_min_milliseconds": 276.80682,
"packets_dropped": 0,
"packets_received": 20,
"packets_sent": 20,
"protocol": "tcp",
"target": "aws.amazon.com:80",
"timestamp": "2022-05-07T19:14:17"
}
Example (Ethernet)
{
"code": "PING",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "SoHo",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.1229939f2df8",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.118",
"mac_address": "20:4c:03:34:a8:0c",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Apple Store",
"sensor_serial": "ZAGMKLR01J",
"sensor_uid": "7070ff29-4fef-47d4-9d89-fadad8528588",
"service_name": "Google",
"service_uid": "-LazAi-fSY_fVaBy-s07"
},
"jitter_milliseconds": 90.973236,
"latency_max_milliseconds": 306.57816,
"latency_milliseconds": 196.85919,
"latency_min_milliseconds": 0.68187714,
"packets_dropped": 0,
"packets_received": 20,
"packets_sent": 20,
"protocol": "tcp",
"target": "www.google.com:80",
"timestamp": "2022-05-07T19:13:39"
}
Code: VOIP_MOS
This test runs a TCP PING to a specified target a and computes a MOS score.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “VOIP_MOS”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID of the test result |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
jitter_milliseconds |
| float | Measured jitter in ms |
latency_max_milliseconds |
| float | Measured max latency in ms |
latency_milliseconds |
| float | Average latency in ms |
latency_min_milliseconds |
| float | Measured min latency in ms |
mean_opinion_score |
| float | MOS score |
packets_dropped |
| int | Number of packets dropped |
packets_received |
| int | Number of packets received |
packets_sent |
| int | Number of packets sent |
protocol |
| string | Protocol: always "tcp” |
target |
| string | Target of the test request |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "VOIP_MOS",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Student Services",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.55b89fc397d5",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.159",
"mac_address": "20:4c:03:36:4b:cd",
"network_name": "Cape",
"network_uid": "ssid-b4806328a465",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"qbss": {
"available_admission_capacity": 0,
"channel_utilisation": 0.153,
"station_count": 22
},
"secondary_dns": "10.44.11.11",
"sensor_name": "Student Union",
"sensor_serial": "ZAGRKLR024",
"sensor_uid": "c7cd434f-f9b9-4edd-82b6-6be9cb015b9b",
"service_name": "Microsoft Teams",
"service_uid": "teams",
"wifi_bssid": "58:b6:33:3e:03:cc",
"wifi_channel": 136,
"wifi_frequency": 5.68,
"wifi_signal_level": -35,
"wifi_ssid": "Cape"
},
"jitter_milliseconds": 19.456108,
"latency_max_milliseconds": 572.293,
"latency_milliseconds": 183.38931,
"latency_min_milliseconds": 136.374,
"mean_opinion_score": 3.9045131,
"packets_dropped": 2,
"packets_received": 98,
"packets_sent": 100,
"protocol": "tcp",
"target": "13.107.8.2",
"timestamp": "2022-05-07T19:16:12"
}
Example (Ethernet):
{
"code": "VOIP_MOS",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "Univ East Campus",
"hierarchy_node_path": "447ce3d76388.4930ce0d5ef0.dfef87578c2f.fe3f06c66732.cbf1a41f4229.2c46f078cebc",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.124",
"mac_address": "20:4c:03:48:af:a2",
"network_name": "Ethernet",
"network_uid": "ethernet-fbe769e02743",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Student Store",
"sensor_serial": "CNH3KLQ07Q",
"sensor_uid": "178b9020-c488-45b8-b2d9-cc21edb57752",
"service_name": "VoIP Application",
"service_uid": "-M2QiAZxZ8YA-BIc1KPn"
},
"jitter_milliseconds": 5.325874,
"latency_max_milliseconds": 249.59207,
"latency_milliseconds": 235.73834,
"latency_min_milliseconds": 226.439,
"mean_opinion_score": 4.007298,
"packets_dropped": 0,
"packets_received": 100,
"packets_sent": 100,
"protocol": "tcp",
"target": "52.15.179.221",
"timestamp": "2022-05-07T19:15:38"
}
Code: TELNET
This test measures tty connectivity.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “TELNET”. |
connect_time_milliseconds |
| float | Time to connect in ms |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID of the test result |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
target |
| string | Target of the TELNET request |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code":"TELNET",
"connect_time_milliseconds":175.88488000001234,
"context":{
"category":"internal_or_external",
"customer_uid":"d641ea5b-77df-4d60-9c18-ef6ce2a3606f",
"hierarchy_node_name": "retail store 2424",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.55b89fc397d1",
"default_gateway":"192.168.1.1",
"dhcp_server":"192.168.1.1",
"interface_name":"wlan0",
"interface_type":"wifi",
"ip_address":"192.168.1.222",
"mac_address":"20:4c:03:4e:45:e3",
"network_name": "SJ_Office_2.4",
"network_uid":"ssid-d3975589dd49",
"operator":"wlan0",
"primary_dns":"192.168.1.1",
"sensor_name": "Kiosk",
"sensor_serial": "ZAGRKLR024",
"sensor_uid": "c7cd434f-f9b9-4edd-82b6-6be9cb015b9b",
"service_name": "Telnet Server",
"service_uid": "MqtjUVSTEPowCxWQi21",
"wifi_bssid":"74:83:c2:8e:c5:d8",
"wifi_channel":44,
"wifi_frequency":5.22,
"wifi_signal_level":-19,
"wifi_ssid":"SJ_Office"
},
"target":"192.168.1.1:22",
"timestamp": "2022-05-07T19:16:12"
}
Code: WEB_APP
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “WEB_APP”. |
commands |
| list | List of commands run in the web app test. |
| command_number | int | Step number in the web app test |
| execution_time_milliseconds | float | Time to complete the command |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “network”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
execution_time_milliseconds |
| float | Total time to complete all steps within the web app test |
target |
| string | Target of the web app test |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi)
{
"code": "WEB_APP",
"commands": [
{
"command_number": 0,
"execution_time_milliseconds": 4197.6367
},
{
"command_number": 1,
"execution_time_milliseconds": 2972.9453
},
{
"command_number": 2,
"execution_time_milliseconds": 1512.3607
},
{
"command_number": 3,
"execution_time_milliseconds": 568.1607
},
{
"command_number": 4,
"execution_time_milliseconds": 827.2921
}
],
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "St. George East",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.6d7468f7536d.2ed8af24e01c.027da6838816",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.150",
"mac_address": "20:4c:03:37:32:8d",
"network_name": "Cape",
"network_uid": "ssid-b4806328a465",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"qbss": {
"available_admission_capacity": 0,
"channel_utilisation": 0.133,
"station_count": 23
},
"secondary_dns": "10.44.11.11",
"sensor_name": "TM CheckIn",
"sensor_serial": "CNGPKLQ02L",
"sensor_uid": "18e7b3df-fcbc-4086-8c74-3edb6786f6fb",
"service_name": "Aruba Networks Website",
"service_uid": "-Mf5R0-igEBFXZ2j6H4W",
"wifi_bssid": "58:b6:33:3e:03:cc",
"wifi_channel": 136,
"wifi_frequency": 5.68,
"wifi_signal_level": -34,
"wifi_ssid": "Cape"
},
"execution_time_milliseconds": 10078.3955,
"target": "www.arubanetworks.com",
"timestamp": "2022-05-07T19:15:32"
}
Example (Ethernet)
{
"code": "WEB_APP",
"commands": [
{
"command_number": 0,
"execution_time_milliseconds": 346.59232
},
{
"command_number": 1,
"execution_time_milliseconds": 2188.6943
},
{
"command_number": 2,
"execution_time_milliseconds": 2622.7307
},
{
"command_number": 3,
"execution_time_milliseconds": 6350.29
}
],
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "SoHo Penthouse",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.1229939f2df8",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.118",
"mac_address": "20:4c:03:34:a8:0c",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Store",
"sensor_serial": "ZAGMKLR01J",
"sensor_uid": "7070ff29-4fef-47d4-9d89-fadad8528588",
"service_name": "Aruba Networks Website",
"service_uid": "-MtF0G21B2Hv5Jr_4Vsc"
},
"execution_time_milliseconds": 11508.308,
"target": "www.arubanetworks.com",
"timestamp": "2022-05-07T19:29:59"
}
Code: IPERF2
This test runs IPERF2 to test upload speed.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “IPERF2”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
elapsed_time_milliseconds |
| float | Time spent running the test |
protocol
|
| string | Protocol for the iperf test. Either “tcp” or ”udp”
|
speed_upload_bps |
| float | Measured upload speed |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
tx_bytes |
| int | Transmitted bytes |
Example (Wi-Fi):
{
"code": "IPERF2",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Theater Arts Prod",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.b2340a342cf4",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.146",
"mac_address": "20:4c:03:37:34:0d",
"network_name": "Cape",
"network_uid": "ssid-b4806328a465",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"qbss": {
"available_admission_capacity": 0,
"channel_utilisation": 0.353,
"station_count": 30
},
"secondary_dns": "10.44.11.11",
"sensor_name": "Waterfront Garden",
"sensor_serial": "CNGPKLQ02S",
"sensor_uid": "24c740b4-6461-449e-bbc6-8c56e91ee399",
"service_name": "iPerf2_test",
"service_uid": "-N1UxLPUy76bSqqn_g60",
"wifi_bssid": "58:b6:33:3e:03:cc",
"wifi_channel": 136,
"wifi_frequency": 5.68,
"wifi_signal_level": -86,
"wifi_ssid": "Cape"
},
"elapsed_time_milliseconds": 11396.036,
"protocol": "tcp",
"speed_upload_bps": 4828076.0,
"timestamp": "2022-05-07T19:41:56",
"tx_bytes": 6155176
}
Example (Ethernet)
{
"code": "IPERF2",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "SoHo",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.1229939f2df8",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.118",
"mac_address": "20:4c:03:34:a8:0c",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Store",
"sensor_serial": "ZAGMKLR01J",
"sensor_uid": "7070ff29-4fef-47d4-9d89-fadad8528588",
"service_name": "iPerf2_test",
"service_uid": "-N1UxLPUy76bSqqn_g60"
},
"elapsed_time_milliseconds": 11307.805,
"protocol": "tcp",
"speed_upload_bps": 5014345.0,
"timestamp": "2022-05-07T19:51:14",
"tx_bytes": 6534824
}
Code: IPERF3
This test runs IPERF3 to test upload or download speed.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “IPERF3”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
elapsed_time_milliseconds |
| float | Time spent running the test |
protocol
|
| string | Protocol for the iperf test. Either “tcp” or ”udp”
|
rx_bytes |
| int | Received bytes (only applies to download tests) |
speed_download_bps |
| float | Measured download speed (only applies to download tests) |
speed_upload_bps |
| float | Measured upload speed (only applies to upload tests) |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
tx_bytes |
| int | Transmitted bytes (only applies to upload tests) |
Example (Wi-Fi):
{
"code": "IPERF3",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "St Peters West",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.772333c59852",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.142",
"mac_address": "20:4c:03:37:2c:4d",
"network_name": "Cape",
"network_uid": "ssid-b4806328a465",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"qbss": {
"available_admission_capacity": 0,
"channel_utilisation": 0.114,
"station_count": 24
},
"secondary_dns": "10.44.11.11",
"sensor_name": "Food Service",
"sensor_serial": "CNGPKLQ01S",
"sensor_uid": "49c6de35-a36e-42c0-8574-9f3248c36242",
"service_name": "iPerf3",
"service_uid": "-N1UxGCwPCv0_2dxLBho",
"wifi_bssid": "58:b6:33:3e:03:cc",
"wifi_channel": 136,
"wifi_frequency": 5.68,
"wifi_signal_level": -30,
"wifi_ssid": "Cape"
},
"elapsed_time_milliseconds": 10000.204,
"protocol": "tcp",
"rx_bytes": 3850232,
"speed_download_bps": 3080122.8,
"timestamp": "2022-05-07T19:51:21"
}
Code: YOUTUBE_THROUGHPUT
Name |
| Type | Comments |
audio_codec |
| string | Audio codec of the video |
audio_format |
| string | Audio format of the video |
code |
| string | The test result code. Value will always be “YOUTUBE_THROUGHPUT”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
elapsed_time_seconds |
| float | Time playing the youtube video |
max_download_speed_bps |
| float | Max download speed playing the youtube video |
min_download_speed_bps |
| float | Min download speed playing the youtube video |
speed_download_bps |
| float | Average download speed playing the youtube video |
target |
| string | Target of the video |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
video_codec |
| string | Video codec |
video_format |
| string | Video format |
video_quality |
| string | Video Quality |
video_size_bytes |
| int | Size of the video in bytes |
Example )Ethernet):
{
"audio_codec": "mp4a.40.2",
"audio_format": "140 - audio only (tiny)",
"code": "YOUTUBE_THROUGHPUT",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "Cambridge",
"hierarchy_node_path": "447ce3d76388.4930ce0d5ef0.dfef87578c2f.fe3f06c66732.2a2f593ea39a",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.120",
"mac_address": "20:4c:03:36:4e:0c",
"network_name": "Ethernet",
"network_uid": "ethernet-fbe769e02743",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Harvard University",
"sensor_serial": "ZAGRKLR02F",
"sensor_uid": "5ed42e51-a3f8-4620-a9ea-a6358829be3d",
"service_name": "YouTube",
"service_uid": "youtube"
},
"elapsed_time_seconds": 15.19713,
"max_download_speed_bps": 421432.0,
"min_download_speed_bps": 409234.0,
"speed_download_bps": 415774.0,
"target": "https://www.youtube.com/watch?v=IZJ48x7LsHg",
"timestamp": "2022-05-07T19:55:26",
"video_codec": "vp9",
"video_format": "243 - 640x360 (360p)",
"video_quality": "360p",
"video_size_bytes": 8093260
}
Code: SPEED
This test uses fast.com to measure download speed.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “SPEED”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
speed_download_bps |
| float | Measured download speed
|
target |
| string | Target of the test. Will always be “www.fast.com” |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "SPEED",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Bay Harbor",
"hierarchy_node_path": "447ce3d76388.4930ce0d5ef0.dfef87578c2f.fe3f06c66732.cbf1a41f4229",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.151",
"mac_address": "20:4c:03:37:34:cd",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Center Place",
"sensor_serial": "CNGPKLQ02W",
"sensor_uid": "70ad762a-40e8-4ebc-9d7c-334970e20267",
"service_name": "Netflix (Fast.com)",
"service_uid": "fast",
"wifi_bssid": "cc:d0:83:15:85:90",
"wifi_channel": 36,
"wifi_frequency": 5.18,
"wifi_signal_level": -41,
"wifi_ssid": "ATM Demo - Psk"
},
"speed_download_bps": 22428936.0,
"target": "www.fast.com",
"timestamp": "2022-05-07T20:59:51"
}
Code: LIBRESPEED
This test uses measures upload and download speed with librespeed.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “LIBRESPEED”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
jitter_milliseconds |
| float | Measured jitter in ms |
latency_milliseconds |
| float | Measured latency in ms |
server_name |
| string | Librespeed server name. Can be blank. |
speed_download_bps |
| float | Measured download speed in bps
|
speed_upload_bps |
| float | Measured upload speed in bps |
target |
| string | Target of the test. |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "LIBRESPEED",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Patient Lobby",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.6d7468f7536d.1356ea275c29",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.140",
"mac_address": "20:4c:03:37:2b:8d",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Safe Patient Admissions",
"sensor_serial": "CNGPKLQ01P",
"sensor_uid": "83c7f688-54bf-43b7-8a70-d5602dd90ef9",
"service_name": "Librespeed test Atlanta",
"service_uid": "-MqtkvhwbL3e7CYkqI-L",
"wifi_bssid": "cc:d0:83:15:85:90",
"wifi_channel": 36,
"wifi_frequency": 5.18,
"wifi_signal_level": -54,
"wifi_ssid": "ATM Demo - Psk"
},
"jitter_milliseconds": 0.25,
"latency_milliseconds": 235.09091,
"server_name": "Atlanta, United States (Clouvider)",
"speed_download_bps": 7390000.0,
"speed_upload_bps": 28500000.0,
"target": "https://atl.speedtest.clouvider.net/backend",
"timestamp": "2022-05-08T01:54:10"
}
Code: DROPBOX_THROUGHPUT
This test measures download speed from your Dropbox account.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “DROPBOX_THROUGHPUT”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
rx_bytes |
| int | Received bytes |
speed_download_bps |
| float | Measured download speed
|
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Wi-Fi):
{
"code": "DROPBOX_THROUGHPUT",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"hierarchy_node_name": "Faculty Lounge",
"hierarchy_node_path": "447ce3d76388.a6a68155b8ee.25c8ce982c8e.aca91eb89b5a.74f6d236ded9",
"interface_name": "wlan0",
"interface_type": "wifi",
"ip_address": "10.12.7.144",
"mac_address": "20:4c:03:48:ba:a3",
"network_name": "ATM Demo - Psk",
"network_uid": "ssid-fb1d500a62cf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Performing Arts",
"sensor_serial": "CNH3KLQ094",
"sensor_uid": "5b3d9cf9-055e-462b-8006-5ba24ee6e799",
"service_name": "Dropbox",
"service_uid": "dropbox",
"wifi_bssid": "cc:d0:83:15:85:90",
"wifi_channel": 36,
"wifi_frequency": 5.18,
"wifi_signal_level": -43,
"wifi_ssid": "ATM Demo - Psk"
},
"rx_bytes": 1048576,
"speed_download_bps": 2206104.0,
"timestamp": "2022-05-07T21:09:25"
}
Example (Ethernet):
{
"code": "DROPBOX_THROUGHPUT",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "West",
"hierarchy_node_path": "447ce3d76388.0f1e1b9c362e.772333c59852",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.114",
"mac_address": "20:4c:03:36:5a:cc",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Lobby",
"sensor_serial": "ZAGRKLR042",
"sensor_uid": "6338621d-3c9a-42ac-b248-c1ce72d9672b",
"service_name": "Dropbox",
"service_uid": "dropbox"
},
"rx_bytes": 1048576,
"speed_download_bps": 2247904.0,
"timestamp": "2022-05-07T21:04:38"
}
Code: SLACK_API
This test measures the response of the slack API.
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “SLACK_API”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| ethernet_duplex_mode | string | Duplex mode of the ethernet connection. Only present on test results over ethernet. |
| ethernet_link_speed_bps | int | Link speed of the ethernet connection. Only present on test results over ethernet. |
| interface_name | string | Interface name for the test result. Value is either “wlan0” or “eth0” |
| interface_type | string | Interface type for the test result. Value is either “wifi” or “ethernet” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. “eth0” is ethernet, “wlan0” is Wi-Fi and “eth3” is cellular. |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
elapsed_time_milliseconds
|
| float | Time taken to successfully test the Slack API
|
target |
| string | Target of the API. Will always be "https://slack.com/api/api.test" |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example (Ethernet)
{
"code": "SLACK_API",
"context": {
"category": "internal_or_external",
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "10.12.6.1",
"dhcp_server": "10.12.6.1",
"ethernet_duplex_mode": "full",
"ethernet_link_speed_bps": 1000000000,
"hierarchy_node_name": "Univ East Campus",
"hierarchy_node_path": "447ce3d76388.4930ce0d5ef0.dfef87578c2f.fe3f06c66732.cbf1a41f4229.2c46f078cebc",
"interface_name": "eth0",
"interface_type": "ethernet",
"ip_address": "10.12.7.124",
"mac_address": "20:4c:03:48:af:a2",
"network_name": "VLAN28",
"network_uid": "ethernet-71be1ef4fdc9",
"operator": "eth0",
"primary_dns": "10.44.10.11",
"secondary_dns": "10.44.11.11",
"sensor_name": "Student Store",
"sensor_serial": "CNH3KLQ07Q",
"sensor_uid": "178b9020-c488-45b8-b2d9-cc21edb57752",
"service_name": "Slack",
"service_uid": "slack"
},
"elapsed_time_milliseconds": 1272.4518,
"target": "https://slack.com/api/api.test",
"timestamp": "2022-05-07T19:13:23"
}
Code: ANDROID_BATTERY_STATS
This test measures the current battery state
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “ANDROID_BATTERY_STATS”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| interface_name | string | Interface name for the test result. usually “wlan0” |
| interface_type | string | Interface type for the test result. Value is usually “wifi” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. Will be “wlan0” |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| Zebra context - is_interactive | bool | is the device in use |
| Zebra context - iis_power_save_mode | bool | is the device in power save mode |
| Zebra context - is_device_idle_mode | bool | is the device in idle mode |
charge_percentage
|
| int | current battery percentage
|
charging_method |
| string | string to determine the charging method. Can be "none" |
battery_temp_degrees_celsius |
| int | temperature of the battery in celsius |
battery_health |
| string | health of the battery |
battery_status |
| string | status of the battery (charging or discharging) |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example
{
"charge_percentage": 87,
"charging_method": "none",
"code": "ANDROID_BATTERY_STATS",
"context": {
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "192.168.3.1",
"hierarchy_node_name": "Logistics Warehouse",
"sensor_serial": "763738bb573a37b4",
"sensor_uid": "76c09173-16ae-34d6-a41d-359effc7be1a",
"interface_name": "wlan0",
"dhcp_server": "192.168.3.1",
"wifi_channel": 6,
"zebra_context": {
"is_interactive": false,
"is_power_save_mode": false,
"is_device_idle_mode": true
},
"operator": "wlan0",
"wifi_bit_rate": 243,
"service_uid": null,
"mac_address": "78:B8:D6:D9:F0:15",
"wifi_signal_level": -53,
"interface_type": "wifi",
"wifi_ssid": "uxi_psk",
"wifi_bssid": "9c:8c:d8:2a:44:e0",
"primary_dns": "8.8.8.8",
"network_uid": "ssid-5a4854b02b3b",
"service_name": null,
"hierarchy_node_path": "447ce3d76388.f16e9f950568",
"network_name": "uxi_psk",
"ip_address": "192.168.3.12",
"secondary_dns": "8.8.4.4",
"wifi_frequency": 2.437,
"category": "internal_or_external",
"sensor_name": "TC52AX"
},
"battery_temp_degrees_celsius": 25,
"battery_health": "good",
"battery_status": "discharging",
"timestamp": "2023-03-29T16:51:00"
}
Code: ROAM
This test provides summarized roaming data collected from zebra wireless insights
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “ROAM”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| interface_name | string | Interface name for the test result. usually “wlan0” |
| interface_type | string | Interface type for the test result. Value is usually “wifi” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. Will be “wlan0” |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| Zebra context - is_interactive | bool | is the device in use |
| Zebra context - iis_power_save_mode | bool | is the device in power save mode |
| Zebra context - is_device_idle_mode | bool | is the device in idle mode |
roaming_event
|
| string | ROAM_TYPE_1 - successful roam ROAM_TYPE_2 - successful roam but some type of error was encountered (for example, a retry) ROAM_TYPE_3 - unsuccessful roam, device went into a disconnected state.
RECONNECT_TYPE_1 - new connection without retry RECONNECT_TYPE_2 - new connection with retry RECONNECT_TYPE_3 - new connection failed
|
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example
{
"code": "ROAM",
"roaming_event": "ROAM_TYPE_3",
"context": {
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "192.168.3.1",
"hierarchy_node_name": null,
"sensor_serial": null,
"sensor_uid": "76c09173-16ae-34d6-a41d-359effc7be1a",
"interface_name": "wlan0",
"dhcp_server": "192.168.3.1",
"wifi_channel": 36,
"zebra_context": {
"is_interactive": false,
"is_power_save_mode": false,
"is_device_idle_mode": false
},
"operator": "wlan0",
"wifi_bit_rate": 229,
"service_uid": null,
"mac_address": "78:B8:D6:D9:F0:15",
"wifi_signal_level": -52,
"interface_type": "wifi",
"wifi_ssid": "uxi_psk",
"wifi_bssid": "20:9c:b4:14:44:f0",
"primary_dns": "8.8.8.8",
"network_uid": "ssid-5a4854b02b3b",
"service_name": null,
"hierarchy_node_path": null,
"network_name": null,
"ip_address": "192.168.3.12",
"secondary_dns": "8.8.4.4",
"wifi_frequency": 36,
"category": "wifi",
"sensor_name": null
},
"timestamp": "2023-03-28T00:40:12"
}
Code: VOICE
This test provides summarized voice data collected from zebra wireless insights
Name |
| Type | Comments |
code |
| string | The test result code. Value will always be “VOICE”. |
context |
| object | Dictionary containing context of the test result |
| category | string | Category of the test result. Value will always be “internal_or_external”. |
| customer_uid | string | Customer UID |
| hierarchy_node_name | string | The name of the group directly above the sensor. |
| hierarchy_node_path | string | dot delimited representation of the full sensor hierarchy |
| default_gateway | string | The default gateway |
| dhcp_server | string | The DHCP server |
| interface_name | string | Interface name for the test result. usually “wlan0” |
| interface_type | string | Interface type for the test result. Value is usually “wifi” |
| ip_address | string | IP address of the sensor |
| mac_address | string | MAC address of the sensor |
| network_name | string | Alias of the network as defined in the dashboard |
| network_uid | string | Network UID |
| operator | string | Interface used to report the test result to the dashboard. Will be “wlan0” |
| primary_dns | string | The primary DNS server |
| secondary_dns | string | The secondary DNS server (if applicable) |
| sensor_name | string | Name of the sensor as defined in the dashboard |
| sensor_serial | string | Serial number of the sensor |
| sensor_uid | string | UID of the sensor |
| service_name | string | Name of the service as defined in the dashboard. |
| service_uid | string | UID of the service as defined in the dashboard. |
| wifi_bssid | string | The BSSID of the AP the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_channel | int | The channel the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_frequency | float | The channel frequency the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| wifi_signal_level | int | The RSSI measured by the sensor for this test result. Only present on test results over Wi-Fi. |
| wifi_ssid | string | The SSID the sensor is connected to for this test result. Only present on test results over Wi-Fi. |
| Zebra context - is_interactive | bool | is the device in use |
| Zebra context - iis_power_save_mode | bool | is the device in power save mode |
| Zebra context - is_device_idle_mode | bool | is the device in idle mode |
avg_rssi
|
| int (negative) | average rssi |
avg_snr |
| float | average snr |
avg_voip_mos |
| float | average voip mos |
avg_wifi_quality |
| float | average wifi quality |
avg_jitter_milliseconds |
| float | average jitter in ms |
timestamp |
| timestamp | UTC time for this test result. Format YYYY-MM-DDThh:mm:ss |
Example
{
"code": "VOICE",
"context": {
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"default_gateway": "192.168.3.1",
"hierarchy_node_name": null,
"sensor_serial": null,
"sensor_uid": "76c09173-16ae-34d6-a41d-359effc7be1a",
"interface_name": "wlan0",
"dhcp_server": "192.168.3.1",
"wifi_channel": 36,
"zebra_context": {
"is_interactive": false,
"is_power_save_mode": false,
"is_device_idle_mode": false
},
"operator": "wlan0",
"wifi_bit_rate": 229,
"service_uid": null,
"mac_address": "78:B8:D6:D9:F0:15",
"wifi_signal_level": -52,
"interface_type": "wifi",
"wifi_ssid": "uxi_psk",
"wifi_bssid": "20:9c:b4:14:44:f0",
"primary_dns": "8.8.8.8",
"network_uid": "ssid-5a4854b02b3b",
"service_name": null,
"hierarchy_node_path": null,
"network_name": null,
"ip_address": "192.168.3.12",
"secondary_dns": "8.8.4.4",
"wifi_frequency": 36,
"category": "wifi",
"sensor_name": null
},
"avg_rssi": -42,
"avg_snr": 33.0,
"avg_voip_mos": 4.24437,
"avg_wifi_quality": 5.0,
"avg_jitter_milliseconds" : 5.0,
"timestamp": "2023-03-28T00:40:12"
}