REST Resource: customers.telemetry.events

Resource: TelemetryEvent

Telemetry data reported by a managed device.

JSON representation 
{
  "name": string,
  "device": {
    object (TelemetryDeviceInfo)
  },
  "user": {
    object (TelemetryUserInfo)
  },
  "reportTime": string,
  "eventType": enum (EventType),
  "audioSevereUnderrunEvent": {
    object (TelemetryAudioSevereUnderrunEvent)
  },
  "usbPeripheralsEvent": {
    object (TelemetryUsbPeripheralsEvent)
  },
  "networkStateChangeEvent": {
    object (TelemetryNetworkConnectionStateChangeEvent)
  },
  "httpsLatencyChangeEvent": {
    object (TelemetryHttpsLatencyChangeEvent)
  },
  "wifiSignalStrengthEvent": {
    object (TelemetryNetworkSignalStrengthEvent)
  },
  "vpnConnectionStateChangeEvent": {
    object (TelemetryNetworkConnectionStateChangeEvent)
  }
}
Fields
name

string

Output only. Resource name of the event.
device

object (TelemetryDeviceInfo)

Output only. Information about the device associated with the event.
user

object (TelemetryUserInfo)

Output only. Information about the user associated with the event.
reportTime

string (Timestamp format)

Timestamp that represents when the event was reported.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
eventType

enum (EventType)

The event type of the current event.
audioSevereUnderrunEvent

object (TelemetryAudioSevereUnderrunEvent)

Output only. Payload for audio severe underrun event. Present only when the eventType field is AUDIO_SEVERE_UNDERRUN.
usbPeripheralsEvent

object (TelemetryUsbPeripheralsEvent)

Output only. Payload for usb peripherals event. Present only when the eventType field is either USB_ADDED or USB_REMOVED.
networkStateChangeEvent

object (TelemetryNetworkConnectionStateChangeEvent)

Output only. Payload for network connection state change event. Present only when eventType is NETWORK_STATE_CHANGE.
httpsLatencyChangeEvent

object (TelemetryHttpsLatencyChangeEvent)

Output only. Payload for HTTPS latency change event. Present only when eventType is NETWORK_HTTPS_LATENCY_CHANGE.
wifiSignalStrengthEvent

object (TelemetryNetworkSignalStrengthEvent)

Output only. Payload for WiFi signal strength events. Present only when eventType is WIFI_SIGNAL_STRENGTH_LOW or WIFI_SIGNAL_STRENGTH_RECOVERED.
vpnConnectionStateChangeEvent

object (TelemetryNetworkConnectionStateChangeEvent)

Output only. Payload for VPN connection state change event. Present only when eventType is VPN_CONNECTION_STATE_CHANGE.

TelemetryDeviceInfo

Information about a device associated with telemetry data.

  • Granular Permission needed: TELEMETRY_API_DEVICE
JSON representation 
{
  "deviceId": string,
  "orgUnitId": string
}
Fields
deviceId

string

Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.
orgUnitId

string

Output only. Organization unit ID of the device.

TelemetryUserInfo

Information about a user associated with telemetry data.

  • Granular permission needed: TELEMETRY_API_USER
JSON representation 
{
  "email": string,
  "orgUnitId": string
}
Fields
email

string

Output only. User's email.
orgUnitId

string

Output only. Organization unit ID of the user.

TelemetryAudioSevereUnderrunEvent

This type has no fields.

TelemetryAudioSevereUnderrunEvent is triggered when a audio devices run out of buffer data for more than 5 seconds.

  • Granular permission needed: TELEMETRY_API_AUDIO_REPORT

TelemetryUsbPeripheralsEvent

TelemetryUsbPeripheralsEvent is triggered USB devices are either added or removed.

  • Granular permission needed: TELEMETRY_API_PERIPHERALS_REPORT
JSON representation 
{
  "usbPeripheralReport": [
    {
      object (UsbPeripheralReport)
    }
  ]
}
Fields
usbPeripheralReport[]

object (UsbPeripheralReport)

List of usb devices that were either added or removed.

TelemetryNetworkConnectionStateChangeEvent

TelemetryNetworkConnectionStateChangeEvent is triggered on network connection state changes.

  • Granular permission needed: TELEMETRY_API_NETWORK_REPORT
JSON representation 
{
  "guid": string,
  "connectionState": enum (NetworkConnectionState)
}
Fields
guid

string

Unique identifier of the network.
connectionState

enum (NetworkConnectionState)

Current connection state of the network.

TelemetryHttpsLatencyChangeEvent

Https latency routine is run periodically and TelemetryHttpsLatencyChangeEvent is triggered if a latency problem was detected or if the device has recovered from a latency problem.

  • Granular permission needed: TELEMETRY_API_NETWORK_REPORT
JSON representation 
{
  "httpsLatencyRoutineData": {
    object (HttpsLatencyRoutineData)
  },
  "httpsLatencyState": enum (HttpsLatencyState)
}
Fields
httpsLatencyRoutineData

object (HttpsLatencyRoutineData)

HTTPS latency routine data that triggered the event.
httpsLatencyState

enum (HttpsLatencyState)

Current HTTPS latency state.

HttpsLatencyState

HTTPS latency state.

Enums
HTTPS_LATENCY_STATE_UNSPECIFIED HTTPS latency state is unspecified.
RECOVERY HTTPS latency recovered from a problem.
PROBLEM HTTPS latency problem.

TelemetryNetworkSignalStrengthEvent

TelemetryNetworkSignalStrengthEvent is triggered on WiFi signal strength events.

  • Granular permission needed: TELEMETRY_API_NETWORK_REPORT
JSON representation 
{
  "guid": string,
  "signalStrengthDbm": integer
}
Fields
guid

string

Unique identifier of the network.
signalStrengthDbm

integer

Signal strength RSSI value.

Methods

list

 List telemetry events.