Issue Data
The UXI dashboard displays two types of issues: Threshold Issues and Test Failures.
The issue data available via the data push includes the issue uid, timestamp, sensor details, network, service, issue code, severity and status. You will receive a message when the issue is first detected (confirmed) and when the issue is resolved.
The issue data includes all issues, regardless of whether Incident Detection is enabled or whether mutes are applied. If you are only interested in being notified of incidents, you can enable the webhooks or email notifications.
Issue Schema
The issue schema is the same format for all issues. Some fields may contain null values if the data was not available at the time the issue was detected or is not applicable.
Name | Type | Comments | |
code | string | The issue code. See possible values at the bottom of this document. | |
context | object | Object containing context of the test result | |
| 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_type | string | Interface type for the issue. Value could be “wifi” or "ethernet" | |
| mac_address | string | MAC address of the sensor (May be null) |
| network_name | string | Alias of the network as defined in the dashboard (May be null) |
network_uid | string | Network UID | |
| sensor_name | string | Name of the sensor as defined in the dashboard (May be null) |
| 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. (May be null) | |
service_uid | string | Uid of the service. (May be null) | |
severity | string | Severity of the issue. Will be "WARNING" or "ERROR" | |
status | string | Status of the issue. Will be "CONFIRMED" or "RESOLVED" | |
timestamp | datetime | timestamp in | |
uid | string | Unique uid of the issue. |
Here is a sample of the issue format:
{
"code": "EXTERNAL_SERVICE_UNAVAILABLE",
"context": {
"customer_uid": "7ae10733-a344-4f6c-8bc7-447ce3d76388",
"hierarchy_node_name": "Santa Clara",
"hierarchy_node_path": "447ce3d76388.0e75e34278e4.26160fd950bc",
"interface_type": "ethernet",
"mac_address": "20:4c:03:50:7d:62",
"network_name": "VLAN224",
"network_uid": "ethernet-8fb5a2736eaf",
"sensor_name": "SC Exec Lounge",
"sensor_serial": "CNHJKLQ2M5",
"sensor_uid": "753e82e0-b886-40dc-a9a0-f74529d7a9a0",
"service_name": "Microsoft Teams",
"service_uid": "teams"
},
"severity": "ERROR",
"status": "RESOLVED",
"timestamp": "2022-05-05T19:57:28",
"uid": "d3c0e495-b080-4945-be42-7333959fe09b"
}Note Regarding Names and UIDs:
In the issue data, sensor_name, network_name, hierarchy_node_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_uid (if applicable to the test) and customer_uid will not change.
In addition, the uid for the issue is unique for that issue, so you can identify when the same issue was first detected and resolved.
Issue Codes
You may receive issue data with the following issue codes:
LOW_RSSI |
LOW_BITRATE |
LOW_TX_BITRATE |
LOW_RX_BITRATE |
HIGH_DHCP_RESPONSE_TIME |
HIGH_DNS_RESPONSE_TIME |
EXTERNAL_HIGH_LOSS |
EXTERNAL_HIGH_LATENCY |
INTERNATIONAL_CONNECTIVITY_DOWN |
LOCAL_CONNECTIVITY_DOWN |
DNS_FAILURE |
DNS_UNREACHABLE |
NO_CONNECTIVITY |
GATEWAY_UNREACHABLE |
NO_CONNECTIVITY_DNS |
WIFI_NOT_ASSOCIATED |
DHCP_FAILURE |
DHCP_NO_OFFERS |
DHCP_NO_GATEWAY |
DHCP_NO_ROUTERS |
WIFI_SSID_MISSING |
WIFI_SSID_MISSING_IN_BAND |
WIFI_BSSID_MISSING |
WIFI_BSSID_MISSING_IN_BAND |
WIFI_BSSID_INCORRECT_SSID |
CAPTIVE_PORTAL_HTTP_404 |
CAPTIVE_PORTAL_HTTP_403 |
CAPTIVE_PORTAL_HTTP_500 |
CAPTIVE_PORTAL_HTTP_503 |
CAPTIVE_PORTAL_HTTP_504 |
CAPTIVE_PORTAL_LOGIN_FAILED |
CAPTIVE_PORTAL_WRONG_NET |
CAPTIVE_PORTAL_NO_REDIRECT |
CAPTIVE_PORTAL_CONNECTION_FAILED |
CAPTIVE_PORTAL_INCORRECT_PAGE |
CAPTIVE_PORTAL_TIMEOUT |
CAPTIVE_PORTAL_LIMIT_REACHED |
CAPTIVE_PORTAL_BAD_STATUS_CODE |
CAPTIVE_PORTAL_UNKNOWN_PAGE |
CAPTIVE_PORTAL_TOO_MANY_REDIRECTS |
RSSI_DROP |
INTERNAL_HIGH_LOSS |
INTERNAL_HIGH_LATENCY |
INTERNAL_HIGH_JITTER |
EXTERNAL_HIGH_JITTER |
WIFI_ASSOCIATION_FAILED |
UNEXPECTED_CAPTIVE_PORTAL |
CAPTIVE_PORTAL_NOT_AUTHENTICATED |
POWER_OUTAGE |
INTERNAL_SERVICE_DNS_FAILURE |
EXTERNAL_SERVICE_DNS_FAILURE |
SSID_CASE_INCORRECT |
INTERNAL_SERVICE_UNAVAILABLE |
EXTERNAL_SERVICE_UNAVAILABLE |
INTERNAL_SERVICE_TCP_PING_FAILED |
EXTERNAL_SERVICE_TCP_PING_FAILED |
WIFI_AUTHENTICATION_FAILED |
UNKNOWN_CAPTIVE_PORTAL_FAILURE |
CAPTIVE_PORTAL_LANDING_INACCESSIBLE |
CAPTIVE_PORTAL_INCORRECT_REDIRECT |
CAPTIVE_PORTAL_REDIRECT_CONN |
CAPTIVE_PORTAL_LOGIN_CONN |
CAPTIVE_PORTAL_LOGOUT_CONN |
INTERNAL_HTTP_GENERIC_ERROR |
INTERNAL_HTTP_TIMEOUT |
INTERNAL_HTTP_SERVICE_NOT_KNOWN |
INTERNAL_HTTP_CONNECTION_ERROR |
INTERNAL_HTTP_TOO_MANY_REDIRECTS |
INTERNAL_HTTP_STATUS_CODE_ERROR |
INTERNAL_HTTP_UNKNOWN_ERROR |
INTERNAL_HTTP_REDIRECT_SSL_ERROR |
EXTERNAL_HTTP_GENERIC_ERROR |
EXTERNAL_HTTP_TIMEOUT |
EXTERNAL_HTTP_SERVICE_NOT_KNOWN |
EXTERNAL_HTTP_CONNECTION_ERROR |
EXTERNAL_HTTP_TOO_MANY_REDIRECTS |
EXTERNAL_HTTP_STATUS_CODE_ERROR |
EXTERNAL_HTTP_UNKNOWN_ERROR |
EXTERNAL_HTTP_REDIRECT_SSL_ERROR |
INTERNAL_HTTPS_GENERIC_ERROR |
INTERNAL_HTTPS_TIMEOUT |
INTERNAL_HTTPS_SERVICE_NOT_KNOWN |
INTERNAL_HTTPS_CONNECTION_ERROR |
INTERNAL_HTTPS_TOO_MANY_REDIRECTS |
INTERNAL_HTTPS_STATUS_CODE_ERROR |
INTERNAL_HTTPS_UNKNOWN_ERROR |
EXTERNAL_HTTPS_GENERIC_ERROR |
EXTERNAL_HTTPS_TIMEOUT |
EXTERNAL_HTTPS_SERVICE_NOT_KNOWN |
EXTERNAL_HTTPS_CONNECTION_ERROR |
EXTERNAL_HTTPS_TOO_MANY_REDIRECTS |
EXTERNAL_HTTPS_STATUS_CODE_ERROR |
EXTERNAL_HTTPS_UNKNOWN_ERROR |
PRIMARY_DNS_FAILURE |
SECONDARY_DNS_FAILURE |
INTERNAL_SSL_ERROR |
EXTERNAL_SSL_ERROR |
CAPTIVE_PORTAL_NO_CONN_AFTER |
INTERNAL_DNS_NO_ANSWERS |
EXTERNAL_DNS_NO_ANSWERS |
DNS_NO_ANSWERS |
NO_CONNECTIVITY_PAST_PORTAL |
WIFI_4WAY_HANDSHAKE_FAILED |
HIGH_RETRY_RATE |
HIGH_CHANNEL_UTILISATION |
WIFI_8021X_AUTHENTICATION_FAILED |
WIFI_8021X_AUTHENTICATION_TIMEOUT |
WIFI_8021X_AUTHENTICATION_UNKNOWN_CA |
NO_NAMESERVERS_IN_LEASE |
BAD_SKYPE |
AP_SCAN_BSSID_IN_MULTIPLE_CHANNELS |
NO_ETHERNET_CARRIER |
INTERNAL_TELNET_SOCKET_EOF_ERROR |
INTERNAL_TELNET_CONNECTION_ERROR |
INTERNAL_TELNET_PROMPT_NOT_FOUND |
INTERNAL_TELNET_SOCKET_TIMEOUT_ERROR |
EXTERNAL_TELNET_SOCKET_EOF_ERROR |
EXTERNAL_TELNET_CONNECTION_ERROR |
EXTERNAL_TELNET_PROMPT_NOT_FOUND |
EXTERNAL_TELNET_SOCKET_TIMEOUT_ERROR |
HIGH_CAPTIVE_PORTAL_LOAD_TIME |
LOW_INTERNAL_VOIP_MOS |
LOW_EXTERNAL_VOIP_MOS |
HIGH_EXTERNAL_TELNET_ELAPSED_TIME |
HIGH_INTERNAL_TELNET_ELAPSED_TIME |
SLACK_API_TIMEOUT |
SLACK_API_FATAL_ERROR |
SLACK_API_UNKNOWN_ERROR |
SLACK_API_RATE_LIMIT_ERROR |
SLACK_RTM_API_PONG_NOT_FOUND |
SLACK_API_TOKEN_REQUIRED |
SLACK_API_SSL_ERROR |
SLACK_API_LOGIN_ERROR |
SPEEDTEST_CONNECTION_ERROR |
SPEEDTEST_UNKNOWN_ERROR |
YOUTUBEDL_DL_ERROR |
YOUTUBEDL_INFO_ERROR |
YOUTUBEDL_STREAM_ERROR |
SLACK_RTM_API_PONG_TIMEOUT |
ETHERNET_8021X_AUTHENTICATION_FAILED |
ETHERNET_8021X_AUTHENTICATION_TIMEOUT |
ETHERNET_8021X_AUTHENTICATION_UNKNOWN_CA |
STATIC_IP_BAD_CONFIG |
INTERNAL_WEB_APP_TIMEOUT |
EXTERNAL_WEB_APP_TIMEOUT |
INTERNAL_WEB_APP_TARGETS_FAILED |
EXTERNAL_WEB_APP_TARGETS_FAILED |
EXTERNAL_WEB_APP_UNSUPPORTED_PROXY_METHOD |
EXTERNAL_WEB_APP_PROXY_ALERT_TIMEOUT |
EXTERNAL_WEB_APP_UNSUPPORTED_PROXY_TYPE |
EXTERNAL_WEB_APP_PROXY_CONNECTION_REFUSED |
EXTERNAL_WEB_APP_PROXY_AUTH_FAILED |
EXTERNAL_WEB_APP_SSL_ERROR |
INTERNAL_WEB_APP_UNSUPPORTED_PROXY_METHOD |
INTERNAL_WEB_APP_UNSUPPORTED_PROXY_TYPE |
INTERNAL_WEB_APP_PROXY_ALERT_TIMEOUT |
INTERNAL_WEB_APP_PROXY_CONNECTION_REFUSED |
INTERNAL_WEB_APP_PROXY_AUTH_FAILED |
INTERNAL_WEB_APP_SSL_ERROR |
EXTERNAL_WEB_APP_TEST_FAILED |
INTERNAL_WEB_APP_TEST_FAILED |
EXTERNAL_WEB_APP_RUNTIME_ERROR |
INTERNAL_WEB_APP_RUNTIME_ERROR |
EXTERNAL_WEB_APP_UNSUPPORTED_SIDE_SYNTAX |
INTERNAL_WEB_APP_UNSUPPORTED_SIDE_SYNTAX |
WIFI_SCEP_SERVER_BAD_RESPONSE |
WIFI_SCEP_SERVER_NO_RESPONSE |
WIFI_SCEP_SERVER_UNVERIFIABLE |
WIFI_SCEP_BAD_REQUEST |
WIFI_SCEP_DECRYPTION_ERROR |
WIFI_SCEP_FAILURE |
WIFI_SCEP_ENROLLMENT_NETWORK_FAILURE |
ETHERNET_SCEP_SERVER_BAD_RESPONSE |
ETHERNET_SCEP_SERVER_NO_RESPONSE |
ETHERNET_SCEP_SERVER_UNVERIFIABLE |
ETHERNET_SCEP_BAD_REQUEST |
ETHERNET_SCEP_DECRYPTION_ERROR |
ETHERNET_SCEP_FAILURE |
ETHERNET_SCEP_ENROLLMENT_NETWORK_FAILURE |
HIGH_EXTERNAL_WAT_ELAPSED_TIME |
HIGH_INTERNAL_WAT_ELAPSED_TIME |
ZEBRA_ROAM_FAILED |
ZEBRA_VOICE_CALL_FAILED |
INTERNAL_LIBRESPEED_SERVER_ERROR |
EXTERNAL_LIBRESPEED_SERVER_ERROR |
INTERNAL_LIBRESPEED_GENERIC_ERROR |
EXTERNAL_LIBRESPEED_GENERIC_ERROR |
INTERNAL_LIBRESPEED_TIMEOUT |
EXTERNAL_LIBRESPEED_TIMEOUT |