Opendata Specification

page

Pagination cursor. Return measurements starting at this page

size

Maximum number of measurements to return per page. A request always returns a single page.

q

Full text query. Restricts the returned results to fit the given query. The fully detailed instructions on the query language can be found on the elastic search page.

sort

Sorting parameter. Specified as <field_name>,<asc|desc> (e.g. sort=end_time,asc)

implausible

Flag to mark this measurement as implausible. An implausible result is one that could not have been measured that way. This flag exists for potentially tampered results, so they do not count as valid results (e.g. to prevent tampering w/statistics).

version_protocol

The protocol version this measurement used, if available.

version_library

The library version this measurement used, if available.

relative_start_time_ns

Start time in nanoseconds relative to the start time of the overall measurement object.

relative_end_time_ns

End time in nanoseconds relative to the end time of the overall measurement object.

start_time

Start Date and time for this sub measurement. Date and time is always stored as UTC.

end_time

End Date and time for this sub measurement. Date and time is always stored as UTC.

duration_ns

Duration of a measurement, in nanoseconds.

status

The status of a measurement (i.e. STARTED, FINISHED, FAILED, ABORTED).

reason

The reason why a measurement failed.

throughput_avg_download_bps

The calculated (average) download throughput in bits per second.

throughput_avg_download_log

Common logarithm of the (average) download throughput.

throughput_avg_upload_bps

The calculated (average) upload throughput in bits per second.

throughput_avg_upload_log

Common logarithm of the average upload throughput.

bytes_download

Bytes received during the speed measurement (Download).

bytes_download_including_slow_start

Bytes received during the speed measurement (Download) with slow-start phase.

bytes_upload

Bytes transferred during the speed measurement (Upload).

bytes_upload_including_slow_start

Bytes transferred during the speed measurement (Upload) with slow-start phase.

requested_duration_download_ns

The nominal measurement duration of the download measurement, in nanoseconds.

requested_duration_upload_ns

The nominal measurement duration of the upload measurement, in nanoseconds.

duration_rtt_ns

Duration of the RTT measurement, in nanoseconds.

duration_rtt_tcp_ns

Duration of the RTT TCP measurement, in nanoseconds.

duration_download_ns

Duration of the download measurement, in nanoseconds.

duration_upload_ns

Duration of the upload measurement, in nanoseconds.

relative_start_time_rtt_ns

Relative start time of the RTT measurement in nanoseconds.

relative_start_time_download_ns

Relative start time of the download measurement in nanoseconds.

relative_start_time_upload_ns

Relative start time of the upload measurement in nanoseconds.

rtt_info

Contains round trip time information measured during the measurement, see Round-trip-time info.

rtt_tcp_info

Contains round trip time information measured via TCP during the measurement, see Round-trip-time info.

download_raw_data

Contains a list of all captured byte transfers during the download speed measurement, see throughput raw data.

upload_raw_data

Contains a list of all captured byte transfers during the upload speed measurement, see throughput raw data.

connection_info

Contains information about the connection(s) used for the speed measurement, see server connection info.

address

The address of the measurement server.

rtts

List of all measured RTTs, see single round-trip-time.

requested_num_packets

The number of RTT packets to send, as instructed by the server.

num_sent

The actual number of sent RTT packets.

num_received

The actual number of received RTT packets.

num_error

The actual number of failed RTT packets.

num_missing

The actual number of missing RTT packets.

packet_size

The actual size of RTT packets.

average_ns

Average RTT in nanoseconds.

average_log

Common logarithm of the average RTT.

max_ns

Maximum RTT in nanoseconds.

median_ns

Median RTT in nanoseconds.

median_log

Common logarithm of the median RTT.

standard_deviation_ns

Standard deviation RTT in nanoseconds.

min_ns

Minimum RTT in nanoseconds.

min_log

Common logarithm of the minimum (best) RTT.

max_log

Common logarithm of the maximum (worst) RTT.

variance

Calculated RTT variance.

rtt_ns

Round trip time recorded in nanoseconds.

relative_time_ns

Relative time in nanoseconds (to measurement start).

stream_id

The stream id (numeric value starting from 0).

relative_time_ns

Relative time since start of the speed measurement, in nanoseconds.

bytes

Bytes transmitted or received since start of the speed measurement.

bytes_including_slow_start

Bytes transmitted or received since start of the speed measurement, including the slow start phase.

address

The address of the measurement server.

identifier

The identifier of the measurement server.

ip_address

The ip address of the measurement server (can be either v4 or v6).

port

Port used for the communication.

encrpyted

Indicates if the communication with the measurement server was encrypted.

encryption_info

Cryptographic protocol and cipher suite used for encrypted communication, if available. E.g. TLSv1.2 (TLS_RSA_WITH_AES_128_GCM_SHA256).

agent_interface_total_traffic

Contains information about total bytes transferred during the speed measurement, as reported by the measurement agent’s interface, if available. See traffic info for the structure.

agent_interface_download_measurement_traffic

Contains information about bytes transferred during the download measurement, as reported by the measurement agent’s interface, if available. See traffic info for the structure.

agent_interface_upload_measurement_traffic

Contains information about bytes transferred during the upload measurement, as reported by the measurement agent’s interface, if available. See traffic info for the structure.

requested_num_streams_download

The requested number of streams for the download measurement.

requested_num_streams_upload

The requested number of streams for the upload measurement.

actual_num_streams_download

The actual number of streams used by the download measurement.

actual_num_streams_upload

The actual number of streams used by the upload measurement.

tcp_opt_sack_requested

Flag if TCP SACK (Selective Acknowledgement) is enabled/requested.

tcp_opt_wscale_requested

Flag if the TCP window scale options are requested.

server_mss

Maximum Segment Size (MSS) value from the server-side.

server_mtu

Maximum Transmission Unit (MTU) value from the server-side.

rtt_stream_info

Contains a list of connection stream information from the client and the server, obtained from during the round-trip-time measurement, see connection stream info.

download_stream_info

Contains a list of connection stream information from the client and the server, obtained from during the download measurement, see connection stream info.

upload_stream_info

Contains a list of connection stream information from the client and the server, obtained from during the upload measurement, see connection stream info.

local_ip

The local ip used for the connection.

local_port

The local port used for the connection.

remote_ip

The remote ip used for the connection.

remote_port

The remote port used for the connection.

tcp_info

The tcp info obtained during the connection, see the linux definition for technical details.

bytes_rx

Bytes received.

bytes_tx

Bytes transmitted.

results

Contains a list of the achieved results of the given measurement, see evaluated Quality of Service result.

key_to_translation_map

Contains additional information to enhance the results with human-readable information about the executed measurements.

qos_type_to_description_map

Contains additional information to enhance the results with human-readable information about the measurement types.

type

The specific QoS type (e.g. TCP, UDC).

summary

The already translated summary for this QoS measurement.

description

The already translated (and evaluated) description for this QoS measurement.

evaluation_count

The number of QoS objective evaluations that were run.

success_count

The number of successful QoS objective evaluations.

failure_count

The number of failed QoS objective evaluations (= evaluationCount - successCount).

implausible

Flag to mark this QoS measurement as implausible. An implausible QoS result is one that could not have been measured that way. This flag exists for potentially tampered results, so they do not count as valid results (e.g. to prevent tampering w/statistics).

evaluation_keys

Contains all evaluated result keys mapped to their respective results. These are the achieved KPIs of the given measurement, which are used to calculate the results from the result_keys. These can vary wildly depending on the executed Quality of Service measurement.

result_keys

Contains all to be displayed result keys mapped to the corresponding QoSResultOutcome (i.e. OK, INFO, FAIL). The result key may be looked up in the Quality of Service measurement’s key_to_translation_map to generate human-readable results.

blocked_ports

Contains information about blocked ports, mapping the port type (i.e. UDP or TCP) to the corresponding info (see Quality of Service blocked port info).

total_count_blocked_ports

The total number of blocked ports of all blocked port types.

type

The type of the transport protocol, either TCP or UDP.

in_ports

List of all blocked ports (incoming communication).

out_ports

List of all blocked ports (outgoing communication).

in_count

The amount of blocked ports (incoming communication).

out_count

The amount of blocked ports (outgoing communication).

time

Time and date the geographic location information was captured (UTC).

accuracy

Geographic location accuracy.

altitude

Geographic location altitude.

heading

Movement heading.

speed

Movement speed.

provider

Geographic location provider (e.g. GPS).

latitude

Geographic location latitude.

longitude

Geographic location longitude.

relative_time_ns

Relative time in nanoseconds (to measurement start).

is_cgn_detected

Contains true if CGN has been detected, false otherwise. CGN detection is done by checking the traceroute test and the respective results.

network_point_in_time_info

A list of all relevant network information of consecutive points in time, see network point in time.

signals

List of captured signal information, see signal info.

cell_info

Cell location information from a point in time on the measurement agent, see networkcell info.

network_type_id

Network type id as it gets returned by the Android API (see https://developer.android.com/reference/android/telephony/TelephonyManager#getDataNetworkType()).

time

Time and date the signal information was captured (UTC).

relative_time_ns

Relative time in nanoseconds (to measurement start).

wifi_link_speed_bps

The current WiFi link speed, in bits per second (If available).

wifi_rssi_dbm

The received signal strength indicator of the current 802.11 network, in dBm (If available).

signal_strength_2g3g_dbm

The received signal strength of 2G or 3G connections, in dBm (If available).

signal_strength_5g_dbm

The received signal strength of 5G connections, in dBm (If available).

lte_rsrp_dbm

The LTE reference signal received power, in dBm (If available).

lte_rsrq_db

The LTE reference signal received quality, in dB (If available).

lte_rssnr_db

The LTE reference signal signal-to-noise ratio, in dB (If available).

lte_cqi

The LTE channel quality indicator (If available).

wifi_ssid

SSID of the network (if available).

wifi_bssid

BSSID of the network (if available).

cell_id

Contains the cell-ID, if available.

area_code

Contains the area code (e.g. location area code (GSM), tracking area code (LTE)), if available.

primary_scrambling_code

Contains the primary scrambling code, if available.

frequency

Contains the frequency (e.g. 16-bit GSM ARFCN or 18-bit LTE EARFCN), if available.

time

Time and date the signal information was captured (UTC).

relative_time_ns

Relative time in nanoseconds (to measurement start).

agent_public_ip

Anonymized public IP address of the measurement agent.

agent_public_ip_country_code

Country of the measurement agent which is gathered by Geo-IP lookup.

public_ip_rdns

Reverse DNS for the public IP address.

network_type_id

Network type id as it gets returned by the Android API (see https://developer.android.com/reference/android/telephony/TelephonyManager#getDataNetworkType()).

network_type_name

Network type name.

network_type_group_name

Network group name (e.g. 2G, 3G, LAN, etc).

network_type_category

Contains the different network categories.

public_ip_asn

ASN for the public IP address.

public_ip_as_name

Name of ASN.

country_code_asn

Country code derived from the AS (e.g. AT).

provider_name

The name of the provider.

provider_short_name

The short name (or shortcut) of the provider.

ssid

SSID of the network.

frequency

Radio frequency of the wifi network.

network_country

The network operator country code (e.g. AT), if available.

network_operator_mcc_mnc

The MCC/MNC of the network operator, if available.

network_operator_name

The network operator name, if available.

sim_country

The SIM operator country code (e.g. AT), if available.

sim_operator_mcc_mnc

The MCC/MNC of the SIM operator, if available.

sim_operator_name

SIM operator name, if available.

roaming

Indicates if this is a roaming connection, if available (null = unknown).

roaming_type

The roaming type, if available.

nat_type_info

Contains network address translation related information, see Network adress translation info.

mobile_frequency

The computed mobile frequency band of the signal array.

nat_type

Type of network address translation (e.g. LOCAL_TO_LOCAL, NO_NAT).

ip_version

Network address translation IP version.

is_behind_nat

Tells if any type of network address translation has been detected.

os_info

Contains information about the measurement agent’s OS, see operating system info.

code_name

Device code name.

model

Detailed device designation.

full_name

The device name that is commonly known to users (e.g. Google Pixel).

boardid

The measurement probe’s id. Empty if the measurement was not made with a measurement probe.

hostname

The measurement probe’s hostname. Empty if the measurement was not made with a measurement probe.

firmware_image_build_timestamp

The measurement probe’s firmware image build timestamp. Empty if the measurement was not made with a measurement probe.

name

Operating system name (e.g. Android, iOS).

version

Operating system version.

api_level

API level of operating system or SDK (e.g. Android API level or Swift SDK version).

cpu_min

Minimum CPU usage, as double between 0 - 100.

cpu_max

Maximum CPU usage, as double between 0 - 100.

cpu_average

Average CPU usage, as double between 0 - 100.

cpu_median

Median CPU usage, as double between 0 - 100.

memory_min

Minimum Memory usage, as double between 0 - 100.

memory_max

Maximum Memory usage, as double between 0 - 100.

memory_average

Average Memory usage, as double between 0 - 100.

memory_median

Median Memory usage, as double between 0 - 100.

app_version_name

Application version name (e.g. 1.0.0).

app_version_code

Application version code number (e.g. 10).

app_git_revision

Git revision name.

uuid

The agent UUID.

language

The agent’s language.

timezone

The agent’s time zone (e.g. UTC-6h).

type

The type of agent.

client_contract_information

Information pertaining to the internet access contract signed by the given client, see client contract info.

download_kbps

The contractual limit on download throughput.

upload_kbps

The contractual limit on upload throughput.

contract_name

The name of the internet access contract.

provider

The name of the provider of the internet access contract.