Diagnostic Result

This topic lists Data Explorer and API fields (and their descriptions) associated with data returned from a query using TAO’s Diagnostic Tool. The entities described in this topic are considered to be the most meaningful when performing a query of a this data - not all entities returned with a query are listed.

For more information on enabling and using the Diagnostic Tool, see the following topics:

Data Explorer	API	Description
Audio Compatibility	`audioCompatibility`	This field validates whether current network connection satisfies the required parameters. The connection is checked by running files upload and download, plus latency is measured as time for establishing connection to the server. `concurrentUsers`: This value is used only for a text in the warning on the last screen. The number of concurrent users should be defined beforehand and all other metrics should be adjusted accordingly. `download`: `acceptable`: The minimal acceptable value. Displayed in megabits per second (= 4 Mb/s). `measures`: `size`: The size of file downloaded for validation, in MB. `timeout`: Displays how long to wait before aborting check, in milliseconds. `thread`: The number of parallel download streams to run. `jitter`: The variation in latency values over time. `measures`: How many measurements are taken to calculate the middle value. `latency`: The time it takes for data to travel from source to destination and back. `acceptable`: The maximum acceptable value for connection establishment, in milliseconds. `measures`: How many measurements are taken to calculate the middle value. `upload`: `acceptable`: The minimal acceptable value. Displayed in megabits per second (= 4 Mb/s). `measures`: `size`: The size of file downloaded for validation, in MB. `timeout`: Displays how long to wait before aborting check, in milliseconds. `thread`: The number of parallel download streams to run.
Browser Compatibility	`browserCompatibility`	This field validates whether the user’s browser is one of the browsers defined by an administrator in System Settings - Diagnostic Tool. `browser.name`: The name of the user’s browser `browser.version`: The version of the user’s browser. `isSecureBrowser` `true`: the user is using a secure browser. `false`: the user is using a standard browser. `isSecureBrowserEnabled`: This field is only valid when Lockdown Browser is enabled by an administrator. `true`: the system expects or allows the use of a secure browser. `false`: the secure browser is not required or not enabled. `minVersion`: The minimum version specified by an administrator for that browser. `os.name`: The user’s operating system. `os.version`: The version of the user’s operating system `processDenyList.label`: the name for the list of prohibited applications being checked. This field is only valid when Lockdown Browser is enabled by an administrator. `processDenyList.name`: the internal identifier for the deny list used in the check. This field is only valid when Lockdown Browser is enabled by an administrator. `result.accepted`: Whether the browser met the requirements specified by an administrator (`true` / `false`). `resultIsVersionMet`: Whether the browser version met the requirements specified by an administrator (`true` / `false`). `result.listed`: Indicates whether any running processes on the user’s system match items in the deny list (`true` = at least one prohibited process detected). This field is only valid when Lockdown Browser is enabled by an administrator. `result.processList`: provides the list of detected running processes that match the deny list criteria. This field is only valid when Lockdown Browser is enabled by an administrator. `userAgentString`: identifies the user’s browser, operating system, and rendering engine
Connection Compatibility	`connectionCompatibility`	This field validates whether current network connection satisfies the required parameters. The connection is checked by running files upload and download, plus latency is measured as time for establishing connection to the server. See the section on `audioCompatibility` above for more details. This field is only used if `audioCompatibility`is not enabled for the query.
Endpoints Reachability	`endpointsReachability`	This field checks if required list of servers are available by url.
ExecutionTime	executionTime	The exact time the diagnostic test was executed (ISO 8601 format). `2025-04-08T15:41:35.315Z` = April 8, 2025 at 15:41:35.315 UTC
Ip Address		The user’s IP address.
Last Update Date	`last_update_date`	The date and time when the diagnostic result (or record) was last updated or saved in the system (ISO 8601 format).
Tenant Id	`tenantId`	The unique identifier for the TAO environment on which the delivery was executed.
	`webSocketConnection`	This field checks whether the user's browser supports the WebSocket protocol. WebSocket support is required for the test runner engine to function correctly. The timeout value specified in the configuration file determines how long the system waits for a WebSocket response before marking the test as failed. `timeout`: How long to wait for the WebSocket response before marking the test as failed, in milliseconds.
Web Socket Compatibility Enabled		Displays whether the WebSocket check was enabled by an administrator (`true` / `false`).
Additional Data		These fields display which metadata elements were specified by the administrator; the values will display what was entered by the user running the diagnostic test.
Endpoints Reachability		`ping`: measures the response time (in milliseconds) between the user’s system and the endpoint. `reachable`: Indicates whether the endpoint can be successfully accessed. `true` means the endpoint is reachable, while `false` means it is not accessible from the user’s network.
	CODE `bandwidth: { showBandwidthMessage: }`	This field validates how much data the network can handle. It will display as a pass/fail result. `showBandwidthMessage`: Enable or disable the pass/fail result message by setting this field to `true/false`. By default, it is set to `true`.