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)
  },
  "appInstallEvent": {
    object (TelemetryAppInstallEvent)
  },
  "appUninstallEvent": {
    object (TelemetryAppUninstallEvent)
  },
  "appLaunchEvent": {
    object (TelemetryAppLaunchEvent)
  }
}
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.
appInstallEvent

object (TelemetryAppInstallEvent)

Output only. Payload for app install event. Present only when eventType is APP_INSTALLED.
appUninstallEvent

object (TelemetryAppUninstallEvent)

Output only. Payload for app uninstall event. Present only when eventType is APP_UNINSTALLED.
appLaunchEvent

object (TelemetryAppLaunchEvent)

Output only. Payload for app launch event.Present only when eventType is APP_LAUNCHED.

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.

TelemetryAppInstallEvent

App installation data.

JSON representation 
{
  "appInstallSource": enum (ApplicationInstallSource),
  "appInstallReason": enum (ApplicationInstallReason),
  "appInstallTime": enum (ApplicationInstallTime),
  "appId": string,
  "appType": enum (TelemetryApplicationType)
}
Fields
appInstallSource

enum (ApplicationInstallSource)

App installation source.
appInstallReason

enum (ApplicationInstallReason)

App installation reason.
appInstallTime

enum (ApplicationInstallTime)

App installation time depending on the app lifecycle.
appId

string

App id. For PWAs this is the start URL, and for extensions this is the extension id.
appType

enum (TelemetryApplicationType)

Type of app.

ApplicationInstallSource

Describes the app installation source.

Enums
APPLICATION_INSTALL_SOURCE_UNSPECIFIED Application install source is unknown.
APPLICATION_INSTALL_SOURCE_SYSTEM Application installed as part of Chrome OS.
APPLICATION_INSTALL_SOURCE_SYNC Application install source is a sync.
APPLICATION_INSTALL_SOURCE_PLAY_STORE Application install source is the Play store.
APPLICATION_INSTALL_SOURCE_CHROME_WEB_STORE Application install source is the Chrome web store.
APPLICATION_INSTALL_SOURCE_BROWSER Application install source is a browser.

ApplicationInstallReason

Describes the app installation reason.

Enums
APPLICATION_INSTALL_REASON_UNSPECIFIED Application install reason is unknown.
APPLICATION_INSTALL_REASON_SYSTEM Application installed with the system and is considered part of the OS.
APPLICATION_INSTALL_REASON_POLICY Application installed by policy.
APPLICATION_INSTALL_REASON_OEM Application installed by an original equipment manufacturer (OEM).
APPLICATION_INSTALL_REASON_DEFAULT Application installed by default, but is not considered a system app.
APPLICATION_INSTALL_REASON_SYNC Application installed by sync.
APPLICATION_INSTALL_REASON_USER Application installed by user action.
APPLICATION_INSTALL_REASON_SUB_APP Application installed bt SubApp API call.
APPLICATION_INSTALL_REASON_KIOSK Application installed by Kiosk on Chrome OS.
APPLICATION_INSTALL_REASON_COMMAND_LINE Application installed by command line argument.

ApplicationInstallTime

Describes the app installation time depending on the app lifecycle.

Enums
APPLICATION_INSTALL_TIME_UNSPECIFIED Application install time unknown.
APPLICATION_INSTALL_TIME_INIT Application install is initialized.
APPLICATION_INSTALL_TIME_RUNNING Application install is currently running.

TelemetryAppUninstallEvent

App uninstall data.

JSON representation 
{
  "appUninstallSource": enum (ApplicationUninstallSource),
  "appId": string,
  "appType": enum (TelemetryApplicationType)
}
Fields
appUninstallSource

enum (ApplicationUninstallSource)

App uninstall source.
appId

string

App id. For PWAs this is the start URL, and for extensions this is the extension id.
appType

enum (TelemetryApplicationType)

Type of app.

ApplicationUninstallSource

Describes the app uninstall source.

Enums
APPLICATION_UNINSTALL_SOURCE_UNSPECIFIED Application uninstall source unknown.
APPLICATION_UNINSTALL_SOURCE_APP_LIST Application uninstalled from the App List (Launcher).
APPLICATION_UNINSTALL_SOURCE_APP_MANAGEMENT Application uninstalled from the App Managedment page.
APPLICATION_UNINSTALL_SOURCE_SHELF Application uninstalled from the Shelf.
APPLICATION_UNINSTALL_SOURCE_MIGRATION Application uninstalled by app migration.

TelemetryAppLaunchEvent

App launch data.

JSON representation 
{
  "appLaunchSource": enum (ApplicationLaunchSource),
  "appId": string,
  "appType": enum (TelemetryApplicationType)
}
Fields
appLaunchSource

enum (ApplicationLaunchSource)

App launch source.
appId

string

App id. For PWAs this is the start URL, and for extensions this is the extension id.
appType

enum (TelemetryApplicationType)

Type of app.

ApplicationLaunchSource

Describes the app launch source.

Enums
APPLICATION_LAUNCH_SOURCE_UNSPECIFIED Application launch source unknown.
APPLICATION_LAUNCH_SOURCE_APP_LIST_GRID Application launched from the grid of apps, not the search box.
APPLICATION_LAUNCH_SOURCE_APP_LIST_GRID_CONTEXT_MENU Application launched from the grid of apps, off of the context menu.
APPLICATION_LAUNCH_SOURCE_APP_LIST_QUERY Application launched from query-dependent results (larger icons).
APPLICATION_LAUNCH_SOURCE_APP_LIST_QUERY_CONTEXT_MENU Application launched from query-dependent results, off of the context menu.
APPLICATION_LAUNCH_SOURCE_APP_LIST_RECOMMENDATION Application launched from query-less recommendations (smaller icons).
APPLICATION_LAUNCH_SOURCE_PARENTAL_CONTROLS Application launched from the Parental Controls Settings section and Per App time notification.
APPLICATION_LAUNCH_SOURCE_SHELF Application launched from shelf.
APPLICATION_LAUNCH_SOURCE_FILE_MANAGER Application launched from the file manager
APPLICATION_LAUNCH_SOURCE_OMNIBOX Application launched from entering a URL in the Omnibox on the browser.
APPLICATION_LAUNCH_SOURCE_CHROME_INTERNAL Application launched from a Chrome internal call.
APPLICATION_LAUNCH_SOURCE_KEYBOARD Application launched from keyboard shortcut for opening app.
APPLICATION_LAUNCH_SOURCE_OTHER_APP Application launched from clicking a link in another app or WebUI.
APPLICATION_LAUNCH_SOURCE_MENU Application launched from menu.
APPLICATION_LAUNCH_SOURCE_INSTALLED_NOTIFICATION Application launched from the installed notification.
APPLICATION_LAUNCH_SOURCE_TEST Application launched from a test.
APPLICATION_LAUNCH_SOURCE_ARC Application launched from Arc.
APPLICATION_LAUNCH_SOURCE_SHARESHEET Application launched from Sharesheet.
APPLICATION_LAUNCH_SOURCE_RELEASE_NOTES_NOTIFICATION Application launched from the release notes notification.
APPLICATION_LAUNCH_SOURCE_FULL_RESTORE Application launched from a full restore.
APPLICATION_LAUNCH_SOURCE_SMART_TEXT_CONTEXT_MENU Application launched from a smart text selection context menu.
APPLICATION_LAUNCH_SOURCE_DISCOVER_TAB_NOTIFICATION Application launched from a discover tab notification.
APPLICATION_LAUNCH_SOURCE_MANAGEMENT_API Application launched from the Management API.
APPLICATION_LAUNCH_SOURCE_KIOSK Application launched from kiosk.
APPLICATION_LAUNCH_SOURCE_COMMAND_LINE Application launched from the command line.
APPLICATION_LAUNCH_SOURCE_BACKGROUND_MODE Application launched from background mode.
APPLICATION_LAUNCH_SOURCE_NEW_TAB_PAGE Application launched from the new tab page.
APPLICATION_LAUNCH_SOURCE_INTENT_URL Application launched from an intent URL.
APPLICATION_LAUNCH_SOURCE_OS_LOGIN Application launched from OS login.
APPLICATION_LAUNCH_SOURCE_PROTOCOL_HANDLER Application launched from protocol handler.
APPLICATION_LAUNCH_SOURCE_URL_HANDLER Application launched from URL handler.
APPLICATION_LAUNCH_SOURCE_LOCK_SCREEN Application launched from lock screen app launcher.
APPLICATION_LAUNCH_SOURCE_APP_HOME_PAGE Application launched from app home (chrome://apps) page.
APPLICATION_LAUNCH_SOURCE_REPARENTING Application launched from moving content into an app.
APPLICATION_LAUNCH_SOURCE_PROFILE_MENU Application launched from profile menu of installable chrome://password-manager WebUI.
APPLICATION_LAUNCH_SOURCE_SYSTEM_TRAY_CALENDAR Application launched from system tray calendar.
APPLICATION_LAUNCH_SOURCE_INSTALLER Application launched from source installer.
APPLICATION_LAUNCH_SOURCE_FIRST_RUN Count first-run Help app launches separately so that we can understand the number of user-triggered launches.
APPLICATION_LAUNCH_SOURCE_WELCOME_TOUR Application launched from welcome tour.
APPLICATION_LAUNCH_SOURCE_FOCUS_MODE Applicationed launched from focus panel.

Methods

list

 List telemetry events.