REST Resource: customers.telemetry.devices

Resource: TelemetryDevice

Telemetry data collected from a managed device.

  • Granular permission needed: TELEMETRY_API_DEVICE
JSON representation 
{
  "name": string,
  "customer": string,
  "orgUnitId": string,
  "deviceId": string,
  "serialNumber": string,
  "cpuInfo": [
    {
      object (CpuInfo)
    }
  ],
  "cpuStatusReport": [
    {
      object (CpuStatusReport)
    }
  ],
  "memoryInfo": {
    object (MemoryInfo)
  },
  "memoryStatusReport": [
    {
      object (MemoryStatusReport)
    }
  ],
  "networkInfo": {
    object (NetworkInfo)
  },
  "networkStatusReport": [
    {
      object (NetworkStatusReport)
    }
  ],
  "networkDiagnosticsReport": [
    {
      object (NetworkDiagnosticsReport)
    }
  ],
  "osUpdateStatus": [
    {
      object (OsUpdateStatus)
    }
  ],
  "graphicsInfo": {
    object (GraphicsInfo)
  },
  "graphicsStatusReport": [
    {
      object (GraphicsStatusReport)
    }
  ],
  "batteryInfo": [
    {
      object (BatteryInfo)
    }
  ],
  "batteryStatusReport": [
    {
      object (BatteryStatusReport)
    }
  ],
  "storageInfo": {
    object (StorageInfo)
  },
  "storageStatusReport": [
    {
      object (StorageStatusReport)
    }
  ],
  "thunderboltInfo": [
    {
      object (ThunderboltInfo)
    }
  ],
  "audioStatusReport": [
    {
      object (AudioStatusReport)
    }
  ],
  "bootPerformanceReport": [
    {
      object (BootPerformanceReport)
    }
  ],
  "heartbeatStatusReport": [
    {
      object (HeartbeatStatusReport)
    }
  ],
  "kioskAppStatusReport": [
    {
      object (KioskAppStatusReport)
    }
  ],
  "networkBandwidthReport": [
    {
      object (NetworkBandwidthReport)
    }
  ],
  "peripheralsReport": [
    {
      object (PeripheralsReport)
    }
  ],
  "runtimeCountersReport": [
    {
      object (RuntimeCountersReport)
    }
  ]
}
Fields
name

string

Output only. Resource name of the device.
customer

string

Output only. Google Workspace Customer whose enterprise enrolled the device.
orgUnitId

string

Output only. Organization unit ID of the device.
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
serialNumber

string

Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab.
cpuInfo[]

object (CpuInfo)

Output only. Information regarding CPU specs for the device.
cpuStatusReport[]

object (CpuStatusReport)

Output only. CPU status reports collected periodically sorted in a decreasing order of reportTime.
memoryInfo

object (MemoryInfo)

Output only. Information regarding memory specs for the device.
memoryStatusReport[]

object (MemoryStatusReport)

Output only. Memory status reports collected periodically sorted decreasing by reportTime.
networkInfo

object (NetworkInfo)

Output only. Network devices information.
networkStatusReport[]

object (NetworkStatusReport)

Output only. Network specs collected periodically.
networkDiagnosticsReport[]

object (NetworkDiagnosticsReport)

Output only. Network diagnostics collected periodically.
osUpdateStatus[]

object (OsUpdateStatus)

Output only. Contains relevant information regarding ChromeOS update status.
graphicsInfo

object (GraphicsInfo)

Output only. Contains information regarding Graphic peripherals for the device.
graphicsStatusReport[]

object (GraphicsStatusReport)

Output only. Graphics reports collected periodically.
batteryInfo[]

object (BatteryInfo)

Output only. Information on battery specs for the device.
batteryStatusReport[]

object (BatteryStatusReport)

Output only. Battery reports collected periodically.
storageInfo

object (StorageInfo)

Output only. Information of storage specs for the device.
storageStatusReport[]

object (StorageStatusReport)

Output only. Storage reports collected periodically.
thunderboltInfo[]

object (ThunderboltInfo)

Output only. Information on Thunderbolt bus.
audioStatusReport[]

object (AudioStatusReport)

Output only. Audio reports collected periodically sorted in a decreasing order of reportTime.
bootPerformanceReport[]

object (BootPerformanceReport)

Output only. Boot performance reports of the device.
heartbeatStatusReport[]

object (HeartbeatStatusReport)

Output only. Heartbeat status report containing timestamps periodically sorted in decreasing order of reportTime
kioskAppStatusReport[]

object (KioskAppStatusReport)

Output only. Kiosk app status report for the kiosk device
networkBandwidthReport[]

object (NetworkBandwidthReport)

Output only. Network bandwidth reports collected periodically sorted in a decreasing order of reportTime.
peripheralsReport[]

object (PeripheralsReport)

Output only. Peripherals reports collected periodically sorted in a decreasing order of reportTime.
runtimeCountersReport[]

object (RuntimeCountersReport)

Output only. Runtime counters reports collected device lifetime runtime, as well as the counts of S0->S3, S0->S4, and S0->S5 transitions, meaning entering into sleep, hibernation, and power-off states

CpuInfo

CPU specifications for the device

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportDeviceCpuInfo
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_CPU_INFO
JSON representation 
{
  "model": string,
  "architecture": enum (Architecture),
  "maxClockSpeed": integer,
  "keylockerSupported": boolean,
  "keylockerConfigured": boolean
}
Fields
model

string

Output only. The CPU model name. Example: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz
architecture

enum (Architecture)

Output only. Architecture type for the CPU.

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportDeviceCpuInfo
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
maxClockSpeed

integer

Output only. The max CPU clock speed in kHz.
keylockerSupported

boolean

Output only. Whether keylocker is supported.
keylockerConfigured

boolean

Output only. Whether keylocker is configured.TRUE = Enabled; FALSE = disabled. Only reported if keylockerSupported = TRUE.

Architecture

Architecture type for the CPU.

Enums
ARCHITECTURE_UNSPECIFIED Architecture unknown.
X64 x64 architecture

CpuStatusReport

Provides information about the status of the CPU.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceCpuInfo
  • Data Collection Frequency: Every 10 minutes
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_CPU_REPORT
JSON representation 
{
  "reportTime": string,
  "sampleFrequency": string,
  "cpuUtilizationPct": integer,
  "cpuTemperatureInfo": [
    {
      object (CpuTemperatureInfo)
    }
  ]
}
Fields
reportTime

string (Timestamp format)

Output only. The timestamp in milliseconds representing time at which this report was sampled.

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".
sampleFrequency

string (Duration format)

Output only. Frequency the report is sampled.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
cpuUtilizationPct

integer

Output only. Sample of CPU utilization (0-100 percent).
cpuTemperatureInfo[]

object (CpuTemperatureInfo)

Output only. CPU temperature sample info per CPU core in Celsius

CpuTemperatureInfo

CPU temperature of a device. Sampled per CPU core in Celsius.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceCpuInfo
  • Data Collection Frequency: Every 10 minutes
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
JSON representation 
{
  "temperatureCelsius": integer,
  "label": string
}
Fields
temperatureCelsius

integer

Output only. CPU temperature in Celsius.
label

string

Output only. CPU label. Example: Core 0

MemoryInfo

Memory information of a device.

  • This field has both telemetry and device information:
    • totalRamBytes - Device information
    • availableRamBytes - Telemetry information
    • totalMemoryEncryption - Device information
  • Data for this field is controlled via policy: ReportDeviceMemoryInfo
  • Data Collection Frequency:
    • totalRamBytes - Only at upload
    • availableRamBytes - Every 10 minutes
    • totalMemoryEncryption - at device startup
  • Default Data Reporting Frequency:
    • totalRamBytes - 3 hours
    • availableRamBytes - 3 hours
    • totalMemoryEncryption - at device startup
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: only for totalMemoryEncryption
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_MEMORY_INFO
JSON representation 
{
  "totalRamBytes": string,
  "availableRamBytes": string,
  "totalMemoryEncryption": {
    object (TotalMemoryEncryptionInfo)
  }
}
Fields
totalRamBytes

string (int64 format)

Output only. Total RAM in bytes.
availableRamBytes

string (int64 format)

Output only. Amount of available RAM in bytes.
totalMemoryEncryption

object (TotalMemoryEncryptionInfo)

Output only. Total memory encryption info for the device.

TotalMemoryEncryptionInfo

Memory encryption information of a device.

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportDeviceMemoryInfo
  • Data Collection Frequency: At device startup
  • Default Data Reporting Frequency: At device startup
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes
  • Reported for affiliated users only: N/A
JSON representation 
{
  "encryptionState": enum (MemoryEncryptionState),
  "maxKeys": string,
  "keyLength": string,
  "encryptionAlgorithm": enum (MemoryEncryptionAlgorithm)
}
Fields
encryptionState

enum (MemoryEncryptionState)

The state of memory encryption on the device.
maxKeys

string (int64 format)

The maximum number of keys that can be used for encryption.
keyLength

string (int64 format)

The length of the encryption keys.
encryptionAlgorithm

enum (MemoryEncryptionAlgorithm)

Memory encryption algorithm.

MemoryEncryptionState

The state of memory encryption on the device.

Enums
MEMORY_ENCRYPTION_STATE_UNSPECIFIED Memory encryption state is not set.
MEMORY_ENCRYPTION_STATE_UNKNOWN The memory encryption state is unknown.
MEMORY_ENCRYPTION_STATE_DISABLED Memory encrpytion on the device is disabled.
MEMORY_ENCRYPTION_STATE_TME Memory encryption on the device uses total memory encryption.
MEMORY_ENCRYPTION_STATE_MKTME Memory encryption on the device uses multi-key total memory encryption.

MemoryEncryptionAlgorithm

The encryption algorithm being used on the device.

Enums
MEMORY_ENCRYPTION_ALGORITHM_UNSPECIFIED Memory encryption algorithm is not set.
MEMORY_ENCRYPTION_ALGORITHM_UNKNOWN The memory encryption algorithm being used is unknown.
MEMORY_ENCRYPTION_ALGORITHM_AES_XTS_128 The memory encryption algorithm is using the AES_XTS encryption algorithm with a 128 bit block cypher.
MEMORY_ENCRYPTION_ALGORITHM_AES_XTS_256 The memory encryption algorithm is using the AES_XTS encryption algorithm with a 256 bit block cypher.

MemoryStatusReport

Contains samples of memory status reports.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceMemoryInfo
  • Data Collection Frequency: Only at upload, SystemRamFreeByes is collected every 10 minutes
  • Default Data Reporting Frequency: Every 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_MEMORY_REPORT
JSON representation 
{
  "reportTime": string,
  "sampleFrequency": string,
  "systemRamFreeBytes": string,
  "pageFaults": integer
}
Fields
reportTime

string (Timestamp format)

Output only. The timestamp in milliseconds representing time at which this report was sampled.

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".
sampleFrequency

string (Duration format)

Output only. Frequency the report is sampled.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
systemRamFreeBytes

string (int64 format)

Output only. Amount of free RAM in bytes (unreliable due to Garbage Collection).
pageFaults

integer

Output only. Number of page faults during this collection

NetworkInfo

Network device information.

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportNetworkDeviceConfiguration
  • Data Collection Frequency: At device startup
  • Default Data Reporting Frequency: At device startup
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_NETWORK_INFO
JSON representation 
{
  "networkDevices": [
    {
      object (NetworkDevice)
    }
  ]
}
Fields
networkDevices[]

object (NetworkDevice)

Output only. List of network devices.

NetworkDevice

Details about the network device.

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportNetworkDeviceConfiguration
  • Data Collection Frequency: At device startup
  • Default Data Reporting Frequency: At device startup
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes
  • Reported for affiliated users only: N/A
JSON representation 
{
  "type": enum (NetworkDeviceType),
  "macAddress": string,
  "meid": string,
  "imei": string,
  "iccid": string,
  "mdn": string
}
Fields
type

enum (NetworkDeviceType)

Output only. Network device type.
macAddress

string

Output only. MAC address (if applicable) of the corresponding network device.
meid

string

Output only. MEID (if applicable) of the corresponding network device.
imei

string

Output only. IMEI (if applicable) of the corresponding network device.
iccid

string

Output only. The integrated circuit card ID associated with the device's sim card.
mdn

string

Output only. The mobile directory number associated with the device's sim card.

NetworkDeviceType

Network devices types.

Enums
NETWORK_DEVICE_TYPE_UNSPECIFIED Network device type not specified.
CELLULAR_DEVICE Cellular device.
ETHERNET_DEVICE Ethernet device.
WIFI_DEVICE Wifi device.

NetworkStatusReport

State of visible/configured networks.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportNetworkStatus
  • Data Collection Frequency: 60 minutes
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes
  • Reported for affiliated users only: Yes
  • Granular permission needed: TELEMETRY_API_NETWORK_REPORT
JSON representation 
{
  "reportTime": string,
  "sampleFrequency": string,
  "signalStrengthDbm": integer,
  "lanIpAddress": string,
  "gatewayIpAddress": string,
  "transmissionBitRateMbps": string,
  "receivingBitRateMbps": string,
  "transmissionPowerDbm": integer,
  "encryptionOn": boolean,
  "wifiLinkQuality": string,
  "wifiPowerManagementEnabled": boolean,
  "guid": string,
  "connectionState": enum (NetworkConnectionState),
  "connectionType": enum (NetworkType)
}
Fields
reportTime

string (Timestamp format)

Output only. Time at which the network state 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".
sampleFrequency

string (Duration format)

Output only. Frequency the report is sampled.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
signalStrengthDbm

integer

Output only. Signal strength for wireless networks measured in decibels.
lanIpAddress

string

Output only. LAN IP address.
gatewayIpAddress

string

Output only. Gateway IP address.
transmissionBitRateMbps

string (int64 format)

Output only. Transmission bit rate measured in Megabits per second.
receivingBitRateMbps

string (int64 format)

Output only. Receiving bit rate measured in Megabits per second.
transmissionPowerDbm

integer

Output only. Transmission power measured in decibels.
encryptionOn

boolean

Output only. Whether the wifi encryption key is turned off.
wifiPowerManagementEnabled

boolean

Output only. Wifi power management enabled
guid

string

Output only. Network connection guid.
connectionState

enum (NetworkConnectionState)

Output only. Current connection state of the network.
connectionType

enum (NetworkType)

Output only. Network connection type.

NetworkType

Network connection types.

Enums
NETWORK_TYPE_UNSPECIFIED Network connection type unspecified
CELLULAR Cellular network connection.
ETHERNET Ethernet network connection.
TETHER Tether network connection.
VPN VPN network connection.
WIFI Wifi network connection.

NetworkDiagnosticsReport

Network testing results to determine the health of the device's network connection, for example whether the HTTPS latency is high or normal.

  • Granular permission needed: TELEMETRY_API_NETWORK_REPORT
JSON representation 
{
  "reportTime": string,
  "httpsLatencyData": {
    object (HttpsLatencyRoutineData)
  }
}
Fields
reportTime

string (Timestamp format)

Output only. Timestamp of when the diagnostics were collected.

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".
httpsLatencyData

object (HttpsLatencyRoutineData)

Output only. HTTPS latency test data.

OsUpdateStatus

Contains information regarding the current OS update status.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceOsUpdateStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_OS_REPORT
JSON representation 
{
  "updateState": enum (UpdateState),
  "newPlatformVersion": string,
  "newRequestedPlatformVersion": string,
  "lastUpdateTime": string,
  "lastUpdateCheckTime": string,
  "lastRebootTime": string
}
Fields
updateState

enum (UpdateState)

Output only. Current state of the os update.
newPlatformVersion

string

Output only. New platform version of the os image being downloaded and applied. It is only set when update status is OS_IMAGE_DOWNLOAD_IN_PROGRESS or OS_UPDATE_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for OS_UPDATE_NEED_REBOOT status for some edge cases, e.g. update engine is restarted without a reboot.
newRequestedPlatformVersion

string

Output only. New requested platform version from the pending updated kiosk app.
lastUpdateTime

string (Timestamp format)

Output only. Timestamp of the last successful update.

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".
lastUpdateCheckTime

string (Timestamp format)

Output only. Timestamp of the last update check.

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".
lastRebootTime

string (Timestamp format)

Output only. Timestamp of the last reboot.

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".

UpdateState

State of the OS update

Enums
UPDATE_STATE_UNSPECIFIED State unspecified.
OS_IMAGE_DOWNLOAD_NOT_STARTED OS has not started downloading.
OS_IMAGE_DOWNLOAD_IN_PROGRESS OS has started download on device.
OS_UPDATE_NEED_REBOOT Device needs reboot to finish upload.

GraphicsInfo

Information of the graphics subsystem.

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportDeviceGraphicsStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_GRAPHICS_INFO
JSON representation 
{
  "adapterInfo": {
    object (GraphicsAdapterInfo)
  },
  "eprivacySupported": boolean,
  "displayDevices": [
    {
      object (DisplayDevice)
    }
  ],
  "touchScreenInfo": {
    object (TouchScreenInfo)
  }
}
Fields
adapterInfo

object (GraphicsAdapterInfo)

Output only. Information about the graphics adapter (GPU).
eprivacySupported

boolean

Output only. Is ePrivacy screen supported or not.
displayDevices[]

object (DisplayDevice)

Output only. Information about the display(s) of the device.
touchScreenInfo

object (TouchScreenInfo)

Output only. Information about the internal touch screen(s) of the device.

GraphicsAdapterInfo

Information of a graphics adapter (GPU).

JSON representation 
{
  "adapter": string,
  "driverVersion": string,
  "deviceId": string
}
Fields
adapter

string

Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2).
driverVersion

string

Output only. Version of the GPU driver.
deviceId

string (int64 format)

Output only. Represents the graphics card device id.

DisplayDevice

Information of a display device.

JSON representation 
{
  "displayName": string,
  "displayWidthMm": integer,
  "displayHeightMm": integer,
  "internal": boolean,
  "manufacturerId": string,
  "modelId": integer,
  "manufactureYear": integer
}
Fields
displayName

string

Output only. Display device name.
displayWidthMm

integer

Output only. Display width in millimeters.
displayHeightMm

integer

Output only. Display height in millimeters.
internal

boolean

Output only. Is display internal or not.
manufacturerId

string

Output only. Three letter manufacturer ID.
modelId

integer

Output only. Manufacturer product code.
manufactureYear

integer

Output only. Year of manufacture.

TouchScreenInfo

Information on the device touch screen.

JSON representation 
{
  "touchpadLibrary": string,
  "devices": [
    {
      object (TouchScreenDevice)
    }
  ]
}
Fields
touchpadLibrary

string

Output only. Touchpad library name used by the input stack.
devices[]

object (TouchScreenDevice)

Output only. List of the internal touch screen devices.

TouchScreenDevice

Information of an internal touch screen device.

JSON representation 
{
  "displayName": string,
  "touchPointCount": integer,
  "stylusCapable": boolean
}
Fields
displayName

string

Output only. Touch screen device display name.
touchPointCount

integer

Output only. Number of touch points supported on the device.
stylusCapable

boolean

Output only. Touch screen device is stylus capable or not.

GraphicsStatusReport

Information of the graphics subsystem.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceGraphicsInfo
  • Data Collection Frequency: 3 hours.
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_GRAPHICS_REPORT
JSON representation 
{
  "reportTime": string,
  "displays": [
    {
      object (DisplayInfo)
    }
  ]
}
Fields
reportTime

string (Timestamp format)

Output only. Time at which the graphics data 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".
displays[]

object (DisplayInfo)

Output only. Information about the displays for the device.

DisplayInfo

Information for a display.

JSON representation 
{
  "deviceId": string,
  "resolutionWidth": integer,
  "resolutionHeight": integer,
  "refreshRate": integer,
  "isInternal": boolean,
  "displayName": string
}
Fields
deviceId

string (int64 format)

Output only. Represents the graphics card device id.
resolutionWidth

integer

Output only. Resolution width in pixels.
resolutionHeight

integer

Output only. Resolution height in pixels.
refreshRate

integer

Output only. Refresh rate in Hz.
isInternal

boolean

Output only. Indicates if display is internal or not.
displayName

string

Output only. Display device name.

BatteryInfo

Information about the battery.

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportDevicePowerStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_BATTERY_INFO
JSON representation 
{
  "serialNumber": string,
  "manufacturer": string,
  "designCapacity": string,
  "designMinVoltage": integer,
  "manufactureDate": {
    object (Date)
  },
  "technology": string
}
Fields
serialNumber

string

Output only. Battery serial number.
manufacturer

string

Output only. Battery manufacturer.
designCapacity

string (int64 format)

Output only. Design capacity (mAmpere-hours).
designMinVoltage

integer

Output only. Designed minimum output voltage (mV)
manufactureDate

object (Date)

Output only. The date the battery was manufactured.
technology

string

Output only. Technology of the battery. Example: Li-ion

BatteryStatusReport

Status data for battery.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDevicePowerStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_BATTERY_REPORT
JSON representation 
{
  "reportTime": string,
  "serialNumber": string,
  "sample": [
    {
      object (BatterySampleReport)
    }
  ],
  "batteryHealth": enum (BatteryHealth),
  "fullChargeCapacity": string,
  "cycleCount": integer
}
Fields
reportTime

string (Timestamp format)

Output only. Timestamp of when the sample was collected on device

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".
serialNumber

string

Output only. Battery serial number.
sample[]

object (BatterySampleReport)

Output only. Sampling data for the battery sorted in a decreasing order of reportTime.
batteryHealth

enum (BatteryHealth)

Output only. Battery health.
fullChargeCapacity

string (int64 format)

Output only. Full charge capacity (mAmpere-hours).
cycleCount

integer

Output only. Cycle count.

BatterySampleReport

Sampling data for battery.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDevicePowerStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
JSON representation 
{
  "reportTime": string,
  "voltage": string,
  "remainingCapacity": string,
  "temperature": integer,
  "dischargeRate": integer,
  "chargeRate": integer,
  "current": string,
  "status": string
}
Fields
reportTime

string (Timestamp format)

Output only. Timestamp of when the sample was collected on device

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".
voltage

string (int64 format)

Output only. Battery voltage (millivolt).
remainingCapacity

string (int64 format)

Output only. Battery remaining capacity (mAmpere-hours).
temperature

integer

Output only. Temperature in Celsius degrees.
dischargeRate

integer

Output only. The battery discharge rate measured in mW. Positive if the battery is being discharged, negative if it's being charged.
chargeRate

integer

Output only. Battery charge percentage.
current

string (int64 format)

Output only. Battery current (mA).
status

string

Output only. Battery status read from sysfs. Example: Discharging

BatteryHealth

Represents the battery's current health.

  • This status is not a gauge or the indication of a defective battery. It is calculated by dividing the current full charge capacity by the design capacity.
  • It is up to the Manufacturer to define the battery integrity and the warranty policy.
Enums
BATTERY_HEALTH_UNSPECIFIED Health unknown.
BATTERY_HEALTH_NORMAL Battery is healthy, full charge capacity / design capacity > 80%
BATTERY_REPLACE_SOON Battery is moderately unhealthy and suggested to be replaced soon, full charge capacity / design capacity 75% - 80%
BATTERY_REPLACE_NOW Battery is unhealthy and suggested to be replaced, full charge capacity / design capacity < 75%

StorageInfo

Status data for storage.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceStorageStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_STORAGE_INFO
JSON representation 
{
  "volume": [
    {
      object (DiskVolume)
    }
  ],
  "availableDiskBytes": string,
  "totalDiskBytes": string
}
Fields
volume[]

object (DiskVolume)

Information for disk volumes
availableDiskBytes

string (int64 format)

The available space for user data storage in the device in bytes.
totalDiskBytes

string (int64 format)

The total space for user data storage in the device in bytes.

DiskVolume

Information for disk volumes

JSON representation 
{
  "volumeId": string,
  "storageFreeBytes": string,
  "storageTotalBytes": string
}
Fields
volumeId

string

Disk volume id.
storageFreeBytes

string (int64 format)

Free storage space in bytes.
storageTotalBytes

string (int64 format)

Total storage space in bytes.

StorageStatusReport

Status data for storage.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceStorageStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_STORAGE_REPORT
JSON representation 
{
  "reportTime": string,
  "disk": [
    {
      object (DiskInfo)
    }
  ]
}
Fields
reportTime

string (Timestamp format)

Output only. Timestamp of when the sample was collected on device

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".
disk[]

object (DiskInfo)

Output only. Reports on disk.

DiskInfo

Status of the single storage device.

JSON representation 
{
  "serialNumber": string,
  "manufacturer": string,
  "model": string,
  "sizeBytes": string,
  "type": string,
  "health": string,
  "volumeIds": [
    string
  ],
  "bytesReadThisSession": string,
  "bytesWrittenThisSession": string,
  "readTimeThisSession": string,
  "writeTimeThisSession": string,
  "ioTimeThisSession": string,
  "discardTimeThisSession": string
}
Fields
serialNumber

string

Output only. Disk serial number.
manufacturer

string

Output only. Disk manufacturer.
model

string

Output only. Disk model.
sizeBytes

string (int64 format)

Output only. Disk size.
type

string

Output only. Disk type: eMMC / NVMe / ATA / SCSI.
health

string

Output only. Disk health.
volumeIds[]

string

Output only. Disk volumes.
bytesReadThisSession

string (int64 format)

Output only. Number of bytes read since last boot.
bytesWrittenThisSession

string (int64 format)

Output only. Number of bytes written since last boot.
readTimeThisSession

string (Duration format)

Output only. Time spent reading from disk since last boot.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
writeTimeThisSession

string (Duration format)

Output only. Time spent writing to disk since last boot.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
ioTimeThisSession

string (Duration format)

Output only. Counts the time the disk and queue were busy, so unlike the fields above, parallel requests are not counted multiple times.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
discardTimeThisSession

string (Duration format)

Output only. Time spent discarding since last boot. Discarding is writing to clear blocks which are no longer in use. Supported on kernels 4.18+.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

ThunderboltInfo

Thunderbolt bus info.

  • This field provides device information, which is static and will not change over time.
  • Data for this field is controlled via policy: ReportDeviceSecurityStatus
  • Data Collection Frequency: At device startup
  • Default Data Reporting Frequency: At device startup
    • Policy Controlled: No
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_BUS_DEVICE_INFO
JSON representation 
{
  "securityLevel": enum (ThunderboltSecurityLevel)
}
Fields
securityLevel

enum (ThunderboltSecurityLevel)

Security level of the Thunderbolt bus.

ThunderboltSecurityLevel

Security level of the Thunderbolt bus.

Enums
THUNDERBOLT_SECURITY_LEVEL_UNSPECIFIED Thunderbolt security level is not set.
THUNDERBOLT_SECURITY_NONE_LEVEL All devices are automatically connected by the firmware. No user approval is needed.
THUNDERBOLT_SECURITY_USER_LEVEL User is asked whether the device is allowed to be connected.
THUNDERBOLT_SECURITY_SECURE_LEVEL User is asked whether the device is allowed to be connected. In addition the device is sent a challenge that should match the expected one based on a random key written to the key sysfs attribute
THUNDERBOLT_SECURITY_DP_ONLY_LEVEL The firmware automatically creates tunnels for Thunderbolt.
THUNDERBOLT_SECURITY_USB_ONLY_LEVEL The firmware automatically creates tunnels for the USB controller and Display Port in a dock. All PCIe links downstream of the dock are removed.
THUNDERBOLT_SECURITY_NO_PCIE_LEVEL PCIE tunneling is disabled.

BootPerformanceReport

Boot performance report of a device.

  • This field is telemetry information and this will change over time as the device is utilized.
  • Data for this field is controlled via policy: ReportDeviceBootMode
  • Data Collection Frequency: On every boot up event
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_OS_REPORT
JSON representation 
{
  "bootUpDuration": string,
  "bootUpTime": string,
  "shutdownDuration": string,
  "shutdownTime": string,
  "shutdownReason": enum (ShutdownReason),
  "reportTime": string
}
Fields
bootUpDuration

string (Duration format)

Total time to boot up.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
bootUpTime

string (Timestamp format)

The timestamp when power came on.

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".
shutdownDuration

string (Duration format)

Total time since shutdown start to power off.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
shutdownTime

string (Timestamp format)

The timestamp when shutdown.

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".
shutdownReason

enum (ShutdownReason)

The shutdown reason.
reportTime

string (Timestamp format)

Timestamp when the report was collected.

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".

ShutdownReason

The shutdown reason.

Enums
SHUTDOWN_REASON_UNSPECIFIED Shutdown reason is not specified.
USER_REQUEST User initiated.
SYSTEM_UPDATE System update initiated.
LOW_BATTERY Shutdown due to low battery.
OTHER Shutdown due to other reasons.

HeartbeatStatusReport

Heartbeat status report of a device.

  • Available for Kiosks
  • This field provides online/offline/unknown status of a device and will only be included if the status has changed (e.g. Online -> Offline)
  • Data for this field is controlled via policy: HeartbeatEnabled More Info
  • Heartbeat Frequency: 2 mins
    • Note: If a device goes offline, it can take up to 12 minutes for the online status of the device to be updated
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: N/A
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_DEVICE_ACTIVITY_REPORT
JSON representation 
{
  "reportTime": string,
  "state": enum (State)
}
Fields
reportTime

string (Timestamp format)

Timestamp of when status changed was detected

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".
state

enum (State)

State the device changed to

State

The device state

Enums
STATE_UNSPECIFIED State not specified
UNKNOWN Device is not eligible for heartbeat monitoring
ONLINE Device is online
OFFLINE Device is offline

KioskAppStatusReport

Kiosk app status report of a device.

  • Available for Kiosks
  • This field provides the app id and version number running on a kiosk device and the timestamp of when the report was last updated
  • Data for this field is controlled via policy: ReportDeviceSessionStatus
  • Data Collection Frequency: Only at Upload
  • Default Data Reporting Frequency: 3 hours
    • Policy Controlled: Yes
  • Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No
  • Reported for affiliated users only: N/A
  • Granular permission needed: TELEMETRY_API_APPS_REPORT
JSON representation 
{
  "reportTime": string,
  "appId": string,
  "appVersion": string
}
Fields
reportTime

string (Timestamp format)

Timestamp of when report was collected

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".
appId

string

App id of kiosk app for example "mdmkkicfmmkgmpkmkdikhlbggogpicma"
appVersion

string

App version number of kiosk app for example "1.10.118"

RuntimeCountersReport

Runtime counters retrieved from CPU. Currently the runtime counters telemetry is only supported by Intel vPro PSR on Gen 14+.

JSON representation 
{
  "reportTime": string,
  "uptimeRuntimeDuration": string,
  "enterSleepCount": string,
  "enterHibernationCount": string,
  "enterPoweroffCount": string
}
Fields
reportTime

string (Timestamp format)

Timestamp when the report was collected.

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".
uptimeRuntimeDuration

string (Duration format)

Total lifetime runtime. Currently always S0 runtime from Intel vPro PSR.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
enterSleepCount

string (int64 format)

Number of times that the device has entered into the sleep state. Currently obtained via the PSR, count from S0->S3.
enterHibernationCount

string (int64 format)

Number of times that the device has entered into the hibernation state. Currently obtained via the PSR, count from S0->S4.
enterPoweroffCount

string (int64 format)

Number of times that the device has entered into the power-off state. Currently obtained via the PSR, count from S0->S5.

Methods

get

 Get telemetry device.

list

 List all telemetry devices.