This document describes how to use the Wyebot REST API to retrieve data from the Wyebot cloud.
¶ Requirements
In order to interact with the Wyebot API, you must first generate an API Key on the Wyebot dashboard. This can be done from the Management-> API Key. Only dashboard Administrators can generate API Keys - Limited users cannot generate keys.
¶ Wyebot Dashboard Hierarchy
A customer account on the Wyebot dashboard has two levels of hierarchy:
- Location level
- Sensor level
Wyebot sensors within a Location aggregate their data at the Location level. Locations are always referred to by location_id and individual sensors are referred to by sensor_id. Some API requests are valid at both levels and other requests are only valid for one level. See each API definition below for valid levels.
¶ Prometheus Exporter
We published a Prometheus exporter as an example to give our customers an easy way to start using our API without any code.
¶ Sending API Requests
¶ Determine Cloud Name
Wyebot maintains several cloud servers and you must use your cloud server name when making requests. You can determine the cloud name by looking at the address bar in your browser when logged into the Wyebot dashboard. It will be a name similar to:
The examples below use cloud.wyebot.com.
API requests can be made using curl commands. API tools such as Insomnia or Postman can also be used. The API key must always be provided in the request header using the format api_key: <Wyebot API key>.
All times used in API requests or API responses are in UTC/GMT.
¶ Retrieved Output
The data returned from API calls is the most recent data collected. The caller may fetch this data periodically to build historical data over a period of time. The minimum update time for most data in the Wyebot dashboard is 5 minutes, so there is no need to make a specific API call more frequently than that.
¶ Sample Curl Requests
curl "https://{your-cloud-name.wyebot.com}/external_api/org/get_locations" -X GET -H "api_key:xxxxxxxxxxx"
curl "https://{your-cloud-name.wyebot.com}/external_api/org/get_sensors" -X POST -H "api_key:xxxxxxxxxxx" -d "location_id=101"
¶ Sample Insomnia Requests
Insomnia is just one example of a REST client; you can use any REST client or scripting language to make calls to the Wyebot API.
Always include the api_key in the Header section of your REST client:
Get list of SSIDs from individual sensor:
Get list of Access Points from a location:
¶ Possible Errors
| HTTP Error Codes | Errors | Reasons |
|---|---|---|
| 400 | Bad Request | Request failed due to bad input (malformed parameters/request body) |
| 401 | Unauthorized | Invalid or missing API key |
| 404 | Not Found | Invalid request URL or invalid request method |
| 429 | Too Many Requests | API rate limit reached, reduce query frequency or try again later |
| 500 | Internal Server Error | Unexpected error on the server side |
¶ Supported API Calls
¶ Location List
Purpose: Get list of available location_ids and names
Request URL: /external_api/org/get_locations
Request method: GET
Input parameters: None
Expected output parameters:
{
"location_details": {
"status": "SUCCESS",
"data": [{
"location_id": 101,
"location_name": "San Francisco"
},
{
"location_id": 102,
"location_name": "Boston"
}
]}
}
¶ Sensor List
Purpose: Get list of sensors for a given location_id
Request URL: /external_api/org/get_sensors
Request method: POST
Input parameters: {"location_id":<location id>}
Expected output parameters:
{
"sensor_details": {
"status": "SUCCESS",
"data": [
{
"sensor_id": 1010001,
"sensor_name": "First Floor"
},
{
"sensor_id": 1010002,
"sensor_name": "Second Floor"
}
]}
}
¶ Sensor Information
Purpose: Get the sensor information including LLDP data.
Request URL: /external_api/org/get_sensor_info
Request method: POST
Input parameters: {"sensor_id": <sensor id>}
Expected output parameters:
{
"sensor_info": {
"status": "SUCCESS",
"data": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"sensor_status_name": "Active",
"hardware_details": {
"specification": {
"model": "WISXXXX",
"serial_number": "AAAAAAAAAA",
"wireless_mac_address": "aa:aa:aa:aa:aa:aa",
"wired_mac_address": "bb:bb:bb:bb:bb:bb",
"link_speed": "1000Mb/s",
"power_source": "802.3at"
},
"service": {
"uptime": "4 hours, 23 minutes, 54 seconds",
"software_version": "ga-4.2.0.6",
"license_info": "Expires on 09/05/28"
},
"lldp_info": {
"lldp": {
"interface": {
"eth0": {
"via": "lldp",
"age": "0 day, 00:01:38",
"vlan": {
"vlan-id": "10",
"pvid": true
},
"unknown-tlvs": {
"unknown-tlv": {
"subtype": "2",
"oui": "00,16,b9",
"value": "00,01",
"len": "2"
}
},
"chassis": {
"sw01": {
"capability": {
"type": "bridge",
"enabled": true
},
"mgmt-ip": "10.0.10.10",
"id": {
"type": "mac",
"value": "58:20:b1:29:2f:00"
},
"descr": "hp j9773a 2530-24g-poep switch"
}
},
"rid": "36",
"port": {
"auto-negotiation": {
"current": "1000basetfd - four-pair category 5 utp, full duplex mode",
"supported": true,
"enabled": true,
"advertised": [
{
"type": "10base-t",
"fd": true,
"hd": true
},
{
"type": "100base-tx",
"fd": true,
"hd": true
},
{
"type": "1000base-t",
"fd": true,
"hd": false
}
]
},
"descr": "19",
"id": {
"type": "local",
"value": "19"
}
}
}
}
}
}
}
}
}
}
¶ Sensor Network Information
Purpose: Get the sensor’s network information
Request URL: /external_api/org/get_sensor_network_info
Request method: POST
Input parameters: {"sensor_id": <sensor id>}
Expected output parameters:
{
"sensor_network_info": {
"status": "SUCCESS",
"data": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"sensor_status_name": "Active",
"connection_type": "Wired",
"dhcp": true,
"ipaddr": "x.x.x.x",
"ip_subnet": "255.255.255.0",
"ip_gateway": "x.x.x.x",
"dns1": "x.x.x.x",
"dns2": "x.x.x.x",
"wireless_network": ""
}
}
}
¶ Access Point List
Purpose: Get list of access point details from a given location or sensor
Request URL: /external_api/dashboard/accesspointlist
Request method: POST
Input parameters:
To get per location details
{"location_id": <location id>}
To get per sensor details
{"sensor_id": <sensor id>}
Expected output parameters:
{
"access_point_details": {
"status": "SUCCESS",
"data": [
{
"mac_address": "aa:bb:cc:dd:ee:ff",
"hostname": "Sample AP1",
"hostname_type_id": 2,
"channel": "6, 60P+64S",
"phy_type": "802.11ng, 802.11ac",
"max_data_rate": "217, 1300",
"signal_strength": "-50, -47",
"vendor": "Hewlett Packard",
"classification_type": 1
},
{
"mac_address": "11:22:33:44:55:66",
"hostname": "Sample AP2 ",
"hostname_type_id": 2,
"channel": "7, 157",
"phy_type": "802.11ax, 802.11ax",
"max_data_rate": "488, 4083",
"signal_strength": "-62, -80",
"vendor": "Netgear",
"classification_type": 1
}
]
}
}
¶ Client List
Purpose: Get list of wireless client details from a given location or sensor
Request URL: /external_api/dashboard/clientlist
Request method: POST
Input parameters:
To get per location details
{"location_id": <location id>}
To get per sensor details
{"sensor_id": <sensor id>}
Expected output parameters:
{
"client_details": {
"status": "SUCCESS",
"data": [
{
"mac_address": "aa:bb:cc:dd:ee:ff",
"hostname": "Employee1",
"ssid": "abc_guest",
"bssid": "aa:aa:aa:aa:aa:aa",
"vendor": "Samsung Electronics",
"phy_type": "-",
"band_name": "5.0GHz",
"channel": 60
},
{
"mac_address": "11:22:33:44:55:66",
"hostname": "Employee2",
"ssid": "-",
"bssid": "-",
"vendor": "Roku",
"phy_type": "802.11ng",
"band_name": "-",
"channel": 1
}
]
}
}
¶ SSID List
Purpose: Get the WiFi network details from a given location or sensor
Request URL: /external_api/dashboard/ssidlist
Request method: POST
Input parameters:
To get per location details
{"location_id": <location id>}
To get per sensor details
{"sensor_id": <sensor id>}
Expected output parameters:
{
"ssid_details": {
"status": "SUCCESS",
"data": [
{
"ssid": "XFINITY",
"total_bssids": 2,
"security_name": "WPA2 Enterprise",
"hidden_ssid": false,
"bssid_details_array": [
{
"bssid": "11:11:11:11:11:11",
"hostname": "test AP",
"hidden_bssid": false,
"total_clients": "-",
"channel": "149P+153S+157+161",
"signal_strength": -85,
"security_name": "WPA2 Enterprise"
},
{
"bssid": "22:22:22:22:22:22",
"hostname": "22:22:22:22:22:22",
"hidden_bssid": false,
"total_clients": "-",
"channel": "149S+153P",
"signal_strength": -85,
"security_name": "WPA2 Enterprise"
}
]
}
]
}
}
¶ Issue Detail
Purpose: Get the Issue Detail list from a given sensor
Request URL: /external_api/dashboard/sensor_issues
Request method: POST
Input parameters: {"sensor_id": <sensor id>}
Expected output parameters:
{
"issue_details": {
"status": "SUCCESS",
"data": [
{
"severity_name": "major",
"problem": <problem>,
"problem_description": <problem description>,
"solution": <solution>
}
]
}
}
¶ RF Analytics
Purpose: Get the RF analytics from a given location or sensor
Request URL: /external_api/dashboard/rf_analytics
Request method: POST
Input parameters:
To get per location details
{"location_id": <location id>}
To get per sensor details
{"sensor_id": <sensor id>}
Expected output parameters:
// Location level
{
"rf_details": {
"status": "SUCCESS",
"data": [
{
"sensor_id": 1010001,
"sensor_name": "First Floor",
"channel_radio1": 1,
"channel_radio2": 52,
"airtime_percent_radio1": 33,
"airtime_percent_radio2": 3
},
{
"sensor_id": 1010002,
"sensor_name": "Second Floor",
"channel_radio1": 11,
"channel_radio2": 36,
"airtime_percent_radio1": 45,
"airtime_percent_radio2": 12
}
]
}
}
// Sensor level
{
"rf_details": {
"status": "SUCCESS",
"data": {
"rf_analytics_radio_0": {
"channel": 52,
"airtime_total_percent": 6,
"mgmt_percent": 5,
"ctrl_percent": 0,
"data_percent": 0,
"others_percent": 1,
"available_percent": 94,
"noise": -90,
"client_mac_list": [
"aa:aa:aa:aa:aa:aa"
],
"client_hostname_list": [
"My Phone"
],
"client_airtime_percentage": 1
},
"rf_analytics_radio_1": {
"channel": 1,
"airtime_total_percent": 52,
"mgmt_percent": 28,
"ctrl_percent": 1,
"data_percent": 3,
"others_percent": 20,
"available_percent": 94,
"noise_db": -78,
"Client_mac_list": "-",
"Client_hostname_list": "-",
"client_airtime_percentage": -1
}
}
}
}
¶ Client Distribution
Purpose: Get the client distribution details from a given location or sensor
Request URL: /external_api/dashboard/clientdistributionlist
Request method: POST
Input parameters:
To get per location details
{"location_id": <location id>}
To get per sensor details
{"sensor_id": <sensor id>}
Expected output parameters:
{
"client_distribution_list": {
"status": "SUCCESS",
"band_usage_array": [
{
"id": 1,
"category_id": 1,
"band": "5GHz Capable",
"total": 0,
"percentage": "0%"
},
{
"id": 2,
"category_id": 2,
"band": "2.4GHz Limited",
"total": 2,
"percentage": "50%"
},
{
"id": 3,
"category_id": 3,
"band": "5GHz Operation",
"total": 2,
"percentage": "50%"
}
],
"data": [
{
"mac_address": "aa:aa:aa:aa:aa:aa",
"hostname": "aa:aa:aa:aa:aa:aa",
"current_band": "2.4 GHz",
"capability_band": "2.4 GHz",
"category_id": 2,
"vendor": "Roku",
"ssid": "-"
},
{
"mac_address": "bb:bb:bb:bb:bb:bb",
"hostname": "bb:bb:bb:bb:bb:bb",
"current_band": "5.0 GHz",
"capability_band": "5.0 GHz",
"category_id": 3,
"vendor": "Meraki",
"ssid": "meraki_5g"
}
]
}
}
¶ Network Test Profiles
Purpose: To get all the configured network test profiles
Request URL: /external_api/test/get_network_test_profiles
Request method: POST
Input parameters: {"location_id": <location id>}
Expected output parameters:
{
"network_test_profiles": {
"status": "SUCCESS",
"data": [
{
"network_test_profile_id": 1263,
"network_test_profile_name": "Chromebooks",
"network_test_suite_id": 2,
"network_test_suite_name": "Ping",
"ssid": "abc_guest",
"schedule_type_id": 1,
"schedule": "Every 20 minutes",
"enabled": true,
"is_valid": true
},{
"network_test_profile_id": 1385,
"network_test_profile_name": "Device Mon",
"network_test_suite_id": 6,
"network_test_suite_name": "Device Monitor",
"ssid": "Wired",
"schedule_type_id": 1,
"schedule": "Automatic",
"enabled": false,
"is_valid": true
}
]
}
}
¶ Network Test Results Per Test
Purpose: To get all the network test results per test
Request URL: /external_api/test/get_network_test_results
Request method: POST
Input parameters:
{
"location_id": 10907,
"network_test_profile_id": 1264,
"data_range_start_time": "2021-02-21 00:40:00",
"data_range_end_time": "2021-02-25 00:40:00"
}
All times used in API requests or API responses are in UTC/GMT.
Expected output parameters:
// Results include BSSID and channel for Link Doctor test
{
"network_test_results": {
"status": "SUCCESS",
"data": [
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_suite_id": 2,
"network_test_suite_name": "Ping",
"start_time": 1620434428000,
"scheduled_time": "2021-05-07 20:40:00",
"execution_id": 1620420011
},
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_suite_id": 2,
"network_test_suite_name": "Ping",
"start_time": 1620433225000,
"scheduled_time": "2021-05-07 20:20:00",
"execution_id": 1620418810
}
]
}
}
¶ Detailed Network Test Results Per Test Profile
Purpose: To get the detailed network test results per test
Request URL: /external_api/test/get_detailed_network_test_results
Request method: POST
Input parameters:
{
"sensor_id": 1010001,
"network_test_profile_id": 1752,
"execution_id": 1620418810
}
¶ Ping/Link Doctor
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2021-02-24 06:40:00",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 1752,
"network_test_profile_name": "Ping Test",
"network_test_suite_id": 10,
"network_test_suite_name": "Ping",
"start_time": "2021-02-24 06:40:45",
"finish_time": "2021-02-24 06:41:03",
"scheduled_time": "2021-02-24 06:40:00",
"connection_start_time": "2021-02-24 06:40:24",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 9737,
"channel": 60,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Hewlett Packard",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "255.255.255.0",
"dns1_info": [
"x.x.x.x"
],
"dhcp_server": "x.x.x.x",
"captive_portal_time_msec": -1,
"average_rssi": -54,
"current_rssi": -55,
"link_speed_mbps": 400,
"dhcp_retrieval_duration_msec": 3364,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"ping_start_time": "2021-02-24 06:40:45",
"is_wireless": true,
"total_duration_msec": 10203,
"ping_duration_msec": 5358
},
"data": [
{
"status_id": 0,
"hostname": "www.google.com",
"ip_address": "172.217.10.100",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": 0,
"round_trip_time_min_usec": 8129,
"round_trip_time_max_usec": 9860,
"round_trip_time_average_usec": 8576,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 10000
},
{
"status_id": 0,
"hostname": "8.8.8.8",
"ip_address": "8.8.8.8",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": 0,
"round_trip_time_min_usec": 11118,
"round_trip_time_max_usec": 11830,
"round_trip_time_average_usec": 11559,
"dns_status_id": -1,
"ping_dns_resolve_time_usec": -1
}
]
}
}
}
¶ Application
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-17 22:20:00",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 2837,
"network_test_profile_name": "G-Suite",
"network_test_suite_id": 4,
"network_test_suite_name": "Application",
"start_time": "2022-08-17 22:20:13",
"finish_time": "2022-08-17 22:20:21",
"scheduled_time": "2022-08-17 22:20:00",
"connection_start_time": "2022-08-17 22:20:07",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6444,
"channel": 36,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Hewlett Packard",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "255.255.255.0",
"dns1_info": [
"x.x.x.x"
],
"dhcp_server": "x.x.x.x",
"captive_portal_time_msec": -1,
"average_rssi": -51,
"current_rssi": -50,
"link_speed_mbps": 173,
"dhcp_retrieval_duration_msec": 1019,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"application_start_time": "2022-08-17 22:20:13",
"is_wireless": true,
"total_duration_msec": 784,
"application_total_duration_msec": 376
},
"data": [
{
"status_id": 0,
"url": "https://drive.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 62,
"application_dns_resolve_time_usec": 20734
},
{
"status_id": 0,
"url": "https://mail.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 53,
"application_dns_resolve_time_usec": 18689
}
]
}
}
}
¶ Network Discovery
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-17 20:05:39",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 2961,
"network_test_profile_name": "Net Disc",
"network_test_suite_id": 3,
"network_test_suite_name": "Network Discovery",
"start_time": "2022-08-17 20:06:07",
"finish_time": "2022-08-17 20:06:22",
"scheduled_time": "2022-08-17 20:05:39",
"connection_start_time": "2022-08-17 20:06:00",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6367,
"channel": 60,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Hewlett Packard",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "255.255.255.0",
"dns1_info": [ "x.x.x.x" ],
"dhcp_server": "x.x.x.x",
"captive_portal_time_msec": -1,
"average_rssi": -33,
"current_rssi": -26,
"link_speed_mbps": 173,
"dhcp_retrieval_duration_msec": 1044,
"eap_time_msec": 72,
"dhcp_lease_time_seconds": 3600,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": 2,
"dns_threshold_msec": 200,
"network_discovery_result_name": "SUCCESS",
"device_discovery_start_time": "2022-08-17 20:06:07",
"is_wireless": true,
"device_count": 2,
"total_duration_msec": 15186,
"device_discovery_duration_msec": 7774,
"latency_usec": [
5000,
4900
]
},
"data": [
{
"ip_address": "x.x.x.x",
"hostname": "-",
"mac_address": "aa:aa:aa:aa:aa:aa",
"out_vendor": "Fortinet"
},
{
"ip_address": "x.x.x.x",
"hostname": "-",
"mac_address": "bb:bb:bb:bb:bb:bb",
"out_vendor": "Locally Administered"
}
]
}
}
}
¶ Speedtest
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-17 18:50:22",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 2840,
"network_test_profile_name": "Speedtest (WiFi)",
"network_test_suite_id": 5,
"network_test_suite_name": "Speedtest",
"start_time": "2022-08-17 18:52:27",
"finish_time": "2022-08-17 18:52:56",
"scheduled_time": "2022-08-17 18:50:22",
"connection_start_time": "2022-08-17 18:51:15",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 5460,
"channel": 36,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Hewlett Packard",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "255.255.255.0",
"dns1_info": [
"x.x.x.x"
],
"dhcp_server": "x.x.x.x",
"captive_portal_time_msec": -1,
"average_rssi": -50,
"current_rssi": -49,
"link_speed_mbps": 173,
"dhcp_retrieval_duration_msec": 24,
"eap_time_msec": -1,
"dhcp_lease_time_hrs": 24,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"speed_start_time": "2022-08-17 18:52:27",
"is_wireless": true,
"test_result_status_name": "SUCCESS",
"server_info": "new york mega in New York, NY. Distance 271.0 km",
"total_duration_msec": 29412,
"speed_duration_msec": 23927
},
"data": {
"download_speed_mbps": 106,
"upload_speed_mbps": 108,
"download_threshold_mbps": 50,
"upload_threshold_mbps": 1,
"ping_delay_usec": 20263
}
}
}
}
¶ iPerf
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-25 10:30:00",
"status_id": 0,
"iperf_scan_result_status_id": 0,
"iperf_result_status_name": "SUCCESS",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 1084,
"network_test_profile_name": "iPerf test",
"network_test_suite_id": 8,
"network_test_suite_name": "iPerf",
"start_time": "2022-08-25 10:30:11",
"finish_time": "2022-08-25 10:30:39",
"scheduled_time": "2022-08-25 10:30:00",
"connection_start_time": "2022-08-25 10:30:05",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6287,
"channel": 100,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Hewlett Packard",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "255.255.255.0",
"dns1_info": [
"x.x.x.x"
],
"dhcp_server": "x.x.x.x",
"dns_resolve_time": "",
"captive_portal_time_msec": -1,
"average_rssi": -51,
"current_rssi": -51,
"link_speed_mbps": 650,
"dhcp_retrieval_duration_msec": 1010,
"eap_time_msec": -1,
"dhcp_lease_time_hrs": 1,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"iperf_start_time": "2022-08-25 10:30:11",
"is_wireless": true,
"total_duration_msec": 28136,
"iperf_duration_msec": 20838,
"server_info": "x.x.x.x"
},
"data": {
"download_speed_mbps": 331,
"upload_speed_mbps": 278,
"download_threshold_mbps": 50,
"upload_threshold_mbps": 50
}
}
}
}
¶ DNS Performance
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-23 16:30:00",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 3212,
"network_test_profile_name": "DNS issue",
"network_test_suite_id": 9,
"network_test_suite_name": "DNS Performance",
"start_time": "2022-08-23 16:31:24",
"finish_time": "2022-08-23 16:31:31",
"scheduled_time": "2022-08-23 16:30:00",
"connection_start_time": "2022-08-23 16:31:17",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6688,
"channel": 161,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Hewlett Packard",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "255.255.255.0",
"dns1_info": [
"x.x.x.x"
],
"dhcp_server": "x.x.x.x",
"captive_portal_time_msec": -1,
"average_rssi": -31,
"current_rssi": -28,
"link_speed_mbps": 173,
"dhcp_retrieval_duration_msec": 1059,
"eap_time_msec": -1,
"dhcp_lease_time_hrs": 1,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"dns_start_time": "2022-08-23 16:31:24",
"is_wireless": true,
"total_duration_msec": 7946,
"dns_duration_msec": 198
},
"dns_server": [
"x.x.x.x",
"y.y.y.y",
"z.z.z.z"
],
"avg_response_time_usec": [
6942,
16125,
16641
],
"data": [
{
"hostname": "www.google.com",
"dns_result_name": [
{
"id": 0,
"name": "SUCCESS"
},
{
"id": 0,
"name": "SUCCESS"
},
{
"id": 0,
"name": "SUCCESS"
}
],
"response_time_usec": [
12633,
6906,
1984
]
},
{
"hostname": "www.yahoo.com",
"dns_result_name": [
{
"id": 0,
"name": "SUCCESS"
},
{
"id": 0,
"name": "SUCCESS"
},
{
"id": 0,
"name": "SUCCESS"
}
],
"response_time_usec": [
7901,
4673,
9544
]
},
]
}
}
}
¶ Video/Voice
Expected output parameters:
The values of
upstream_mosanddownstream_mosare returned as the MOS score multiplied by 1000. For example, 4366 is a MOS score of 4.366.
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-17 20:13:23",
"status_id": 0,
"vidconf_result_status_id": 0,
"vidconf_result_status_name": "SUCCESS",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 3215,
"network_test_profile_name": "VD",
"network_test_suite_id": 11,
"network_test_suite_name": "Video Conferencing",
"start_time": "2022-08-17 20:15:14",
"finish_time": "2022-08-17 20:15:42",
"scheduled_time": "2022-08-17 20:13:23",
"connection_start_time": "2022-08-17 20:14:36",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6347,
"channel": 36,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Hewlett Packard",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "255.255.255.0",
"dns1_info": [
"x.x.x.x"
],
"dhcp_server": "x.x.x.x",
"captive_portal_time_msec": -1,
"average_rssi": -51,
"current_rssi": -49,
"link_speed_mbps": 173,
"dhcp_retrieval_duration_msec": 1030,
"eap_time_msec": -1,
"dhcp_lease_time_hrs": 24,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"vidconf_start_time": "2022-08-17 20:15:16",
"is_wireless": true,
"total_duration_msec": 20686,
"vidconf_duration_msec": 20346,
"downstream_mos": 4366,
"upstream_mos": 4366
},
"data": [
{
"metric": "Speed (Kbps)",
"downstream": 2004,
"upstream": 1990
},
{
"metric": "Packet Loss (%)",
"downstream": 0,
"upstream": 0
},
{
"metric": "Latency (milliseconds)",
"downstream": 28,
"upstream": 28
},
{
"metric": "Jitter (milliseconds)",
"downstream": 1,
"upstream": 1
}
]
}
}
}
¶ Device Monitor
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-17 22:20:00",
"result": {
"sensor_id": 1010001,
"sensor_name": "First Floor",
"network_test_profile_id": 3214,
"network_test_profile_name": "Dev Mon",
"network_test_suite_id": 6,
"suite_name": "Device Monitor",
"start_time": "2022-08-17 22:21:17",
"finish_time": "2022-08-17 22:21:19",
"device_monitor_start_time": "2022-08-1722:21:17",
"total_duration_msec": 1497,
"device_monitor_duration_msec": 1472
},
"data": [
{
"status_id": 0,
"hostname": "www.yahoo.com",
"ip_address": "74.6.143.26",
"device_monitor_result": "SUCCESS"
}
]
}
}
}
¶ Port Scan
Expected output parameters:
{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2022-08-24 15:00:20",
"status_id": 0,
"hostname": "1.1.1.1",
"ip_address": "8.8.8.8",
"open_port_count": 3,
"port_scan_result_status_id": 0,
"port_scan_result_status_name": "SUCCESS",
"result": {
"sensor_id": 231,
"sensor_name": "Madhuri 231",
"network_test_profile_id": 2842,
"network_test_profile_name": "Port Scan test",
"network_test_suite_id": 7,
"network_test_suite_name": "Port Scan",
"start_time": "2022-08-24 15:03:56",
"finish_time": "2022-08-24 15:04:08",
"scheduled_time": "2022-08-24 15:00:20",
"connection_start_time": "2022-08-24 15:03:49",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6342,
"channel": 36,
"bssid": "aa:aa:aa:aa:aa:aa",
"ssid": "abc_guest",
"vendor": "Cisco Meraki",
"connectivity_ip_address": "x.x.x.x",
"public_ip_address": "x.x.x.x",
"gateway": "x.x.x.x",
"subnet_mask": "x.x.x.x",
"dns1_info": [
"x.x.x.x"
],
"dhcp_server": "x.x.x.x",
"captive_portal_time_msec": -1,
"average_rssi": -52,
"current_rssi": -51,
"link_speed_mbps": 173,
"dhcp_retrieval_duration_msec": 1014,
"eap_time_msec": -1,
"dhcp_lease_time_hrs": 24,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"port_scan_start_time": "2022-08-24 15:03:56",
"is_wireless": true,
"total_duration_msec": 12339,
"port_scan_duration_msec": 4982
},
"data": [
{
"port_number": 53,
"service_name": "domain"
},
{
"port_number": 443,
"service_name": "https"
},
{
"port_number": 8008,
"service_name": "http"
}
]
}
}
}
¶ Network Test Analytics
Purpose: To get the network test analytics in a given location
Request URL: /external_api/dashboard/network_test_analytics
Request method: POST
Input parameters:
{
"location_id": 101,
"data_range_id": 1
}
// data_range_id
// 1 - Past Day
// 2 - Past Week
Expected output parameters:
{
"status": "SUCCESS",
"network_test_stats": {
"test_pass_percent": 98,
"test_fail_percent": 2,
"total_test_runs": 1021,
"tests_passed": 1003,
"tests_failed": 18
},
"data": [
{
"ssid_id": 0,
"ssid": "Wired",
"is_wired": true,
"security_mapping_id": 0,
"dhcp_status": 0,
"dhcp_total_test_runs": 452,
"dhcp_threshold_exceed_count": 0,
"dhcp_threshold_exceed_percent": 0,
"dhcp_threshold_msec": -1,
"radius_status": -1,
"radius_total_test_runs": -1,
"radius_threshold_exceed_count": -1,
"radius_threshold_exceed_percent": -1,
"radius_threshold_msec": -1,
"dns_status": 0,
"dns_total_test_runs": 439,
"dns_threshold_exceed_count": 0,
"dns_threshold_exceed_percent": 0,
"dns_threshold_msec": -1,
"test_status": 1,
"total_test_runs_per_ssid": 452,
"passed_test_runs_per_ssid": 440,
"failed_test_runs_per_ssid": 12,
"passed_test_percent_per_ssid": 97,
"failed_test_percent_per_ssid": 3,
"networkTestArray": [
{
"network_test_job_id": 40,
"network_test_profile_name": "Internet (Wired)",
"total_test_runs_per_profile": 147,
"passed_test_runs_per_profile": 141,
"failed_test_runs_per_profile": 6,
"passed_test_percent_per_profile": 96,
"failed_test_percent_per_profile": 4
},
{
"network_test_job_id": 41,
"network_test_profile_name": "Speedtest (Wired)",
"total_test_runs_per_profile": 12,
"passed_test_runs_per_profile": 6,
"failed_test_runs_per_profile": 6,
"passed_test_percent_per_profile": 50,
"failed_test_percent_per_profile": 50
},
{
"network_test_job_id": 45,
"network_test_profile_name": "Google Workspace",
"total_test_runs_per_profile": 147,
"passed_test_runs_per_profile": 147,
"failed_test_runs_per_profile": 0,
"passed_test_percent_per_profile": 100,
"failed_test_percent_per_profile": 0
},
{
"network_test_job_id": 151,
"network_test_profile_name": "ping 2ww",
"total_test_runs_per_profile": 146,
"passed_test_runs_per_profile": 146,
"failed_test_runs_per_profile": 0,
"passed_test_percent_per_profile": 100,
"failed_test_percent_per_profile": 0
}
]
},
{
"ssid_id": 1125,
"ssid": "abc_guest",
"is_wired": false,
"security_mapping_id": 2,
"dhcp_status": 0,
"dhcp_total_test_runs": 286,
"dhcp_threshold_exceed_count": 0,
"dhcp_threshold_exceed_percent": 0,
"dhcp_threshold": 2000,
"radius_status": 0,
"radius_total_test_runs": 286,
"radius_threshold_exceed_count": 0,
"radius_threshold_exceed_percent": 0,
"radius_threshold": 2000,
"dns_status": 1,
"dns_total_test_runs": 1764,
"dns_threshold_exceed_count": 17,
"dns_threshold_exceed_percent": 1,
"dns_threshold": 200,
"test_status": 1,
"ssid_total_test_runs": 590,
"ssid_passed_test_runs": 584,
"ssid_failed_test_runs": 6,
"ssid_passed_test_percent": 98,
"ssid_failed_test_percent": 2,
"networkTestArray": [
{
"network_test_job_id": 42,
"network_test_profile_name": "Chromebooks",
"total_test_runs_per_profile": 147,
"passed_test_runs_per_profile": 143,
"failed_test_runs_per_profile": 4,
"passed_test_percent_per_profile": 97,
"failed_test_percent_per_profile": 3
},
{
"network_test_job_id": 43,
"network_test_profile_name": "Link Doctor™",
"total_test_runs_per_profile": 147,
"passed_test_runs_per_profile": 146,
"failed_test_runs_per_profile": 1,
"passed_test_percent_per_profile": 99,
"failed_test_percent_per_profile": 1
},
{
"network_test_job_id": 44,
"network_test_profile_name": "Google Workspace",
"total_test_runs_per_profile": 147,
"passed_test_runs_per_profile": 147,
"failed_test_runs_per_profile": 0,
"passed_test_percent_per_profile": 100,
"failed_test_percent_per_profile": 0
},
{
"network_test_job_id": 46,
"network_test_profile_name": "DNS Performance",
"total_test_runs_per_profile": 147,
"passed_test_runs_per_profile": 146,
"failed_test_runs_per_profile": 1,
"passed_test_percent_per_profile": 99,
"failed_test_percent_per_profile": 1
},
{
"network_test_job_id": 47,
"network_test_profile_name": "Speedtest (WiFi)",
"total_test_runs_per_profile": 2,
"passed_test_runs_per_profile": 2,
"failed_test_runs_per_profile": 0,
"passed_test_percent_per_profile": 100,
"failed_test_percent_per_profile": 0
}
]
}
]
}
¶ Get Last Network Test Results
Purpose: Returns the most recent test results for all test profiles and all sensors for a given location_id. This is an efficient way to retrieve detailed network tests results, assuming you are writing the most recent value to your own database.
Request URL: /external_api/test/get_last_network_test_results
Request method: POST
Input parameters:
{
"location_id": <location_id>
}
Click to expand example output
Expected output parameters:{
"network_test_profile_detailed_result_log": {
"status": "SUCCESS",
"network_test_results": {
"network_discovery_test_results": [],
"voice_test_results": [],
"iperf_test_results": [],
"traceroute_test_results": [],
"video_conferencing_test_results": [],
"port_scan_test_results": [],
"speed_test_results": [
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-12 03:10:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1228,
"network_test_profile_name": "Speedtest (Wired)",
"network_test_suite_id": 5,
"network_test_suite_name": "Speedtest",
"start_time": "2025-03-12 03:11:24",
"finish_time": "2025-03-12 03:11:24",
"scheduled_time": "2025-03-12 03:10:00",
"connection_start_time": "2025-03-12 03:11:23",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 782,
"channel": -1,
"bssid": "",
"ap_display_name_by_bssid": "",
"ssid": "",
"vendor": "",
"connectivity_ip_address": "192.168.6.213",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -1,
"current_rssi": -1,
"link_speed_mbps": -1,
"dhcp_retrieval_duration_msec": 0,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"speed_start_time": "2025-03-12 03:11:24",
"is_wireless": false,
"test_result_status_name": "SUCCESS",
"server_info": "Comcast in Boston, MA. Distance 39.57 km",
"total_duration_msec": 783,
"speed_duration_msec": 11472,
"ip_version": 4
},
"data": {
"download_speed_mbps": 579,
"upload_speed_mbps": 509,
"download_threshold_mbps": 200,
"upload_threshold_mbps": 100,
"ping_delay_usec": 6914
}
},
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-12 03:10:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1234,
"network_test_profile_name": "Speedtest (WiFi)",
"network_test_suite_id": 5,
"network_test_suite_name": "Speedtest",
"start_time": "2025-03-12 03:10:18",
"finish_time": "2025-03-12 03:10:26",
"scheduled_time": "2025-03-12 03:10:00",
"connection_start_time": "2025-03-12 03:10:11",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 7006,
"channel": 165,
"bssid": "f2:9e:38:d1:21:ed",
"ap_display_name_by_bssid": "fl3-mr56-lab (f2:9e:38:d1:21:ed)",
"ssid": "wyebot_test",
"vendor": "",
"connectivity_ip_address": "192.168.99.87",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -37,
"current_rssi": -36,
"link_speed_mbps": 286,
"dhcp_retrieval_duration_msec": 1034,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 68402,
"dhcp_threshold_seconds": 0.000005,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"speed_start_time": "2025-03-12 03:10:18",
"is_wireless": true,
"test_result_status_name": "SUCCESS",
"server_info": "Comcast in Boston, MA. Distance 39.57 km",
"total_duration_msec": 8039,
"speed_duration_msec": 19591,
"ip_version": 4
},
"data": {
"download_speed_mbps": 126,
"upload_speed_mbps": 180,
"download_threshold_mbps": 50,
"upload_threshold_mbps": 50,
"ping_delay_usec": 10754
}
}
],
"device_monitor_test_results": [],
"dns_performance_test_results": [
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-14 17:50:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1233,
"network_test_profile_name": "DNS Performance",
"network_test_suite_id": 9,
"network_test_suite_name": "DNS Performance",
"start_time": "2025-03-14 17:50:21",
"finish_time": "2025-03-14 17:50:29",
"scheduled_time": "2025-03-14 17:50:00",
"connection_start_time": "2025-03-14 17:50:12",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6540,
"channel": 165,
"bssid": "f2:9e:38:d1:21:ed",
"ap_display_name_by_bssid": "fl3-mr56-lab (f2:9e:38:d1:21:ed)",
"ssid": "wyebot_test",
"vendor": "",
"connectivity_ip_address": "192.168.99.87",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -41,
"current_rssi": -37,
"link_speed_mbps": 286,
"dhcp_retrieval_duration_msec": 1063,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 0.000005,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"dns_start_time": "2025-03-14 17:50:21",
"is_wireless": true,
"total_duration_msec": 7604,
"dns_duration_msec": 40,
"ip_version": 4
},
"data": [
{
"hostname": "www.yahoo.com",
"dns_result_name": [
"SUCCESS",
"SUCCESS"
],
"dns_server_list": [
"192.168.2.8",
"192.168.2.2"
],
"dns_resolve_time_usec": [
3260,
4419
]
},
{
"hostname": "www.google.com",
"dns_result_name": [
"SUCCESS",
"SUCCESS"
],
"dns_server_list": [
"192.168.2.8",
"192.168.2.2"
],
"dns_resolve_time_usec": [
3180,
3906
]
},
{
"hostname": "www.facebook.com",
"dns_result_name": [
"SUCCESS",
"SUCCESS"
],
"dns_server_list": [
"192.168.2.8",
"192.168.2.2"
],
"dns_resolve_time_usec": [
3904,
4137
]
},
{
"hostname": "www.dropbox.com",
"dns_result_name": [
"SUCCESS",
"SUCCESS"
],
"dns_server_list": [
"192.168.2.8",
"192.168.2.2"
],
"dns_resolve_time_usec": [
3067,
4210
]
},
{
"hostname": "www.apple.com",
"dns_result_name": [
"SUCCESS",
"SUCCESS"
],
"dns_server_list": [
"192.168.2.8",
"192.168.2.2"
],
"dns_resolve_time_usec": [
3133,
7414
]
}
]
}
],
"application_test_results": [
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-14 17:50:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1231,
"network_test_profile_name": "G-Suite",
"network_test_suite_id": 4,
"network_test_suite_name": "Application",
"start_time": "2025-03-14 17:50:18",
"finish_time": "2025-03-14 17:50:26",
"scheduled_time": "2025-03-14 17:50:00",
"connection_start_time": "2025-03-14 17:50:12",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6540,
"channel": 165,
"bssid": "f2:9e:38:d1:21:ed",
"ap_display_name_by_bssid": "fl3-mr56-lab (f2:9e:38:d1:21:ed)",
"ssid": "wyebot_test",
"vendor": "",
"connectivity_ip_address": "192.168.99.87",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -41,
"current_rssi": -37,
"link_speed_mbps": 286,
"dhcp_retrieval_duration_msec": 1063,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 0.000005,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"application_start_time": "2025-03-14 17:50:18",
"is_wireless": true,
"total_duration_msec": 7604,
"application_total_duration_msec": 312,
"ip_version": 4
},
"data": [
{
"status_id": 0,
"url": "https://drive.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 68,
"application_dns_resolve_time_usec": 3696
},
{
"status_id": 0,
"url": "https://mail.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 67,
"application_dns_resolve_time_usec": 4781
},
{
"status_id": 0,
"url": "https://calendar.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 59,
"application_dns_resolve_time_usec": 3446
},
{
"status_id": 0,
"url": "https://sites.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 47,
"application_dns_resolve_time_usec": 3539
},
{
"status_id": 0,
"url": "https://classroom.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 52,
"application_dns_resolve_time_usec": 3525
}
]
},
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-14 17:50:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1232,
"network_test_profile_name": "G-Suite",
"network_test_suite_id": 4,
"network_test_suite_name": "Application",
"start_time": "2025-03-14 17:51:06",
"finish_time": "2025-03-14 17:51:07",
"scheduled_time": "2025-03-14 17:50:00",
"connection_start_time": "2025-03-14 17:51:02",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 586,
"channel": -1,
"bssid": "",
"ap_display_name_by_bssid": "",
"ssid": "",
"vendor": "",
"connectivity_ip_address": "192.168.6.213",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -1,
"current_rssi": -1,
"link_speed_mbps": -1,
"dhcp_retrieval_duration_msec": 0,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"application_start_time": "2025-03-14 17:51:06",
"is_wireless": false,
"total_duration_msec": 587,
"application_total_duration_msec": 349,
"ip_version": 4
},
"data": [
{
"status_id": 0,
"url": "https://drive.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 62,
"application_dns_resolve_time_usec": 716
},
{
"status_id": 0,
"url": "https://mail.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 96,
"application_dns_resolve_time_usec": 658
},
{
"status_id": 0,
"url": "https://calendar.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 73,
"application_dns_resolve_time_usec": 686
},
{
"status_id": 0,
"url": "https://sites.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 62,
"application_dns_resolve_time_usec": 617
},
{
"status_id": 0,
"url": "https://classroom.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 53,
"application_dns_resolve_time_usec": 632
}
]
},
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-14 17:50:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1405,
"network_test_profile_name": "G-Suite",
"network_test_suite_id": 4,
"network_test_suite_name": "Application",
"start_time": "2025-03-14 17:51:08",
"finish_time": "2025-03-14 17:51:09",
"scheduled_time": "2025-03-14 17:50:00",
"connection_start_time": "2025-03-14 17:51:02",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 586,
"channel": -1,
"bssid": "",
"ap_display_name_by_bssid": "",
"ssid": "",
"vendor": "",
"connectivity_ip_address": "192.168.6.213",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -1,
"current_rssi": -1,
"link_speed_mbps": -1,
"dhcp_retrieval_duration_msec": 0,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"application_start_time": "2025-03-14 17:51:08",
"is_wireless": false,
"total_duration_msec": 587,
"application_total_duration_msec": 312,
"ip_version": 4
},
"data": [
{
"status_id": 0,
"url": "https://drive.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 64,
"application_dns_resolve_time_usec": 606
},
{
"status_id": 0,
"url": "https://mail.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 92,
"application_dns_resolve_time_usec": 743
},
{
"status_id": 0,
"url": "https://calendar.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 61,
"application_dns_resolve_time_usec": 665
},
{
"status_id": 0,
"url": "https://sites.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 41,
"application_dns_resolve_time_usec": 630
},
{
"status_id": 0,
"url": "https://classroom.google.com",
"out_application_status_id": 0,
"out_application_status_name": "SUCCESS",
"http_msg": "HTTP/1.1 200 OK",
"application_duration_msec": 51,
"application_dns_resolve_time_usec": 792
}
]
}
],
"ping_test_results": [
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-14 17:50:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1227,
"network_test_profile_name": "Internet (Wired)",
"network_test_suite_id": 2,
"network_test_suite_name": "Ping",
"start_time": "2025-03-14 17:51:03",
"finish_time": "2025-03-14 17:51:03",
"scheduled_time": "2025-03-14 17:50:00",
"connection_start_time": "2025-03-14 17:51:02",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 586,
"channel": -1,
"bssid": "",
"ap_display_name_by_bssid": "",
"ssid": "",
"vendor": "",
"connectivity_ip_address": "192.168.6.213",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -1,
"current_rssi": -1,
"link_speed_mbps": -1,
"dhcp_retrieval_duration_msec": 0,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 2,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"ping_start_time": "2025-03-14 17:51:03",
"is_wireless": false,
"total_duration_msec": 587,
"ping_duration_msec": 3158,
"ip_version": 4
},
"data": [
{
"status_id": 0,
"hostname": "www.yahoo.com",
"ip_address": "69.147.92.11",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 13093,
"round_trip_time_max_usec": 13265,
"round_trip_time_average_usec": 13156,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 735
},
{
"status_id": 0,
"hostname": "www.google.com",
"ip_address": "142.250.72.100",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 7919,
"round_trip_time_max_usec": 8606,
"round_trip_time_average_usec": 8156,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 749
},
{
"status_id": 0,
"hostname": "8.8.8.8",
"ip_address": "8.8.8.8",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 7130,
"round_trip_time_max_usec": 8683,
"round_trip_time_average_usec": 7660,
"dns_status_id": -1,
"ping_dns_resolve_time_usec": -1
}
]
},
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-14 17:50:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1229,
"network_test_profile_name": "Chromebooks",
"network_test_suite_id": 2,
"network_test_suite_name": "Ping",
"start_time": "2025-03-14 17:50:21",
"finish_time": "2025-03-14 17:50:29",
"scheduled_time": "2025-03-14 17:50:00",
"connection_start_time": "2025-03-14 17:50:12",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6540,
"channel": 165,
"bssid": "f2:9e:38:d1:21:ed",
"ap_display_name_by_bssid": "fl3-mr56-lab (f2:9e:38:d1:21:ed)",
"ssid": "wyebot_test",
"vendor": "",
"connectivity_ip_address": "192.168.99.87",
"public_ip_address": "96.233.62.138",
"gateway": "192.168.2.1",
"subnet_mask": "255.255.0.0",
"dns1_info": [
"192.168.2.8",
"192.168.2.2"
],
"dhcp_server": "192.168.2.8",
"captive_portal_time_msec": -1,
"average_rssi": -41,
"current_rssi": -37,
"link_speed_mbps": 286,
"dhcp_retrieval_duration_msec": 1063,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 0.000005,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"ping_start_time": "2025-03-14 17:50:21",
"is_wireless": true,
"total_duration_msec": 7604,
"ping_duration_msec": 5303,
"ip_version": 4
},
"data": [
{
"status_id": 0,
"hostname": "safebrowsing.google.com",
"ip_address": "142.250.80.46",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 9667,
"round_trip_time_max_usec": 10432,
"round_trip_time_average_usec": 9940,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 3334
},
{
"status_id": 0,
"hostname": "dl.google.com",
"ip_address": "142.251.32.110",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 9086,
"round_trip_time_max_usec": 18962,
"round_trip_time_average_usec": 12313,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 4234
},
{
"status_id": 0,
"hostname": "policies.google.com",
"ip_address": "142.250.65.238",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 9893,
"round_trip_time_max_usec": 20166,
"round_trip_time_average_usec": 12822,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 3934
},
{
"status_id": 0,
"hostname": "clients1.google.com",
"ip_address": "142.250.80.46",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 9682,
"round_trip_time_max_usec": 10734,
"round_trip_time_average_usec": 9993,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 25233
},
{
"status_id": 0,
"hostname": "accounts.google.com",
"ip_address": "142.251.16.84",
"ping_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 16572,
"round_trip_time_max_usec": 18283,
"round_trip_time_average_usec": 17240,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 2877
}
]
}
],
"link_doctor_test_results": [
{
"result_status_id": 0,
"result_status_name": "SUCCESS",
"scheduled_time": "2025-03-14 17:40:00",
"result": {
"sensor_id": 213,
"sensor_name": "AH15031998 (213)",
"network_test_profile_id": 1523,
"network_test_profile_name": "testing invalidation",
"network_test_suite_id": 10,
"network_test_suite_name": "Link Doctor™",
"start_time": "2025-03-14 17:40:27",
"finish_time": "2025-03-14 17:40:34",
"scheduled_time": "2025-03-14 17:40:00",
"connection_start_time": "2025-03-14 17:40:20",
"connectivity_result": 0,
"connectivity_result_name": "SUCCESS",
"wireless_duration_msec": 6571,
"channel": 165,
"bssid": "fe:9e:38:d1:21:ed",
"ap_display_name_by_bssid": "fl3-mr56-lab (fe:9e:38:d1:21:ed)",
"ssid": "wyebot_guest",
"vendor": "",
"connectivity_ip_address": "172.16.99.78",
"public_ip_address": "96.233.62.138",
"gateway": "172.16.99.1",
"subnet_mask": "255.255.255.0",
"dns1_info": [
"8.8.8.8",
"8.8.4.4"
],
"dhcp_server": "172.16.99.1",
"captive_portal_time_msec": -1,
"average_rssi": -40,
"current_rssi": -38,
"link_speed_mbps": 58,
"dhcp_retrieval_duration_msec": 1035,
"eap_time_msec": -1,
"dhcp_lease_time_seconds": 86400,
"dhcp_threshold_seconds": 0.000005,
"radius_threshold_seconds": -1,
"dns_threshold_msec": 200,
"v6_client_ip": "",
"v6_gw_ip": "",
"v6_dns1": null,
"v6_dhcp_server": "",
"v6_dhcp_retrieval_time_msec": -1,
"v6_external_ip_addr": "",
"ping_start_time": "2025-03-14 17:40:27",
"is_wireless": true,
"total_duration_msec": 7607,
"ping_duration_msec": 4224,
"ip_version": 4
},
"data": [
{
"status_id": 0,
"hostname": "dns server",
"ip_address": "8.8.8.8",
"link_doctor_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 9738,
"round_trip_time_max_usec": 10302,
"round_trip_time_average_usec": 10101,
"dns_status_id": -1,
"ping_dns_resolve_time_usec": -1
},
{
"status_id": 0,
"hostname": "gateway",
"ip_address": "172.16.99.1",
"link_doctor_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 2286,
"round_trip_time_max_usec": 3265,
"round_trip_time_average_usec": 2683,
"dns_status_id": -1,
"ping_dns_resolve_time_usec": -1
},
{
"status_id": 0,
"hostname": "www.google.com",
"ip_address": "142.250.72.100",
"link_doctor_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 10725,
"round_trip_time_max_usec": 12263,
"round_trip_time_average_usec": 11556,
"dns_status_id": 0,
"ping_dns_resolve_time_usec": 16116
},
{
"status_id": 0,
"hostname": "8.8.8.8",
"ip_address": "8.8.8.8",
"link_doctor_result_name": "SUCCESS",
"transmitted": 4,
"received": 4,
"lost_percent": -1,
"round_trip_time_min_usec": 9604,
"round_trip_time_max_usec": 11491,
"round_trip_time_average_usec": 10408,
"dns_status_id": -1,
"ping_dns_resolve_time_usec": -1
}
]
}
]
}
}
}