- Resource: TelemetryDevice
- CpuInfo
- Architecture
- CpuStatusReport
- CpuTemperatureInfo
- MemoryInfo
- TotalMemoryEncryptionInfo
- MemoryEncryptionState
- MemoryEncryptionAlgorithm
- MemoryStatusReport
- NetworkInfo
- NetworkDevice
- NetworkDeviceType
- NetworkStatusReport
- NetworkType
- NetworkDiagnosticsReport
- OsUpdateStatus
- UpdateState
- GraphicsInfo
- GraphicsAdapterInfo
- DisplayDevice
- TouchScreenInfo
- TouchScreenDevice
- GraphicsStatusReport
- DisplayInfo
- BatteryInfo
- BatteryStatusReport
- BatterySampleReport
- BatteryHealth
- StorageInfo
- DiskVolume
- StorageStatusReport
- DiskInfo
- ThunderboltInfo
- ThunderboltSecurityLevel
- BootPerformanceReport
- ShutdownReason
- HeartbeatStatusReport
- State
- KioskAppStatusReport
- RuntimeCountersReport
- Methods
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 ( |
Fields | |
---|---|
name |
Output only. Resource name of the device. |
customer |
Output only. Google Workspace Customer whose enterprise enrolled the device. |
orgUnitId |
Output only. Organization unit ID of the device. |
deviceId |
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 |
Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab. |
cpuInfo[] |
Output only. Information regarding CPU specs for the device. |
cpuStatusReport[] |
Output only. CPU status reports collected periodically sorted in a decreasing order of |
memoryInfo |
Output only. Information regarding memory specs for the device. |
memoryStatusReport[] |
Output only. Memory status reports collected periodically sorted decreasing by |
networkInfo |
Output only. Network devices information. |
networkStatusReport[] |
Output only. Network specs collected periodically. |
networkDiagnosticsReport[] |
Output only. Network diagnostics collected periodically. |
osUpdateStatus[] |
Output only. Contains relevant information regarding ChromeOS update status. |
graphicsInfo |
Output only. Contains information regarding Graphic peripherals for the device. |
graphicsStatusReport[] |
Output only. Graphics reports collected periodically. |
batteryInfo[] |
Output only. Information on battery specs for the device. |
batteryStatusReport[] |
Output only. Battery reports collected periodically. |
storageInfo |
Output only. Information of storage specs for the device. |
storageStatusReport[] |
Output only. Storage reports collected periodically. |
thunderboltInfo[] |
Output only. Information on Thunderbolt bus. |
audioStatusReport[] |
Output only. Audio reports collected periodically sorted in a decreasing order of |
bootPerformanceReport[] |
Output only. Boot performance reports of the device. |
heartbeatStatusReport[] |
Output only. Heartbeat status report containing timestamps periodically sorted in decreasing order of |
kioskAppStatusReport[] |
Output only. Kiosk app status report for the kiosk device |
networkBandwidthReport[] |
Output only. Network bandwidth reports collected periodically sorted in a decreasing order of |
peripheralsReport[] |
Output only. Peripherals reports collected periodically sorted in a decreasing order of |
appReport[] |
Output only. App reports collected periodically sorted in a decreasing order of |
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 ( |
Fields | |
---|---|
model |
Output only. The CPU model name. Example: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz |
architecture |
Output only. Architecture type for the CPU.
|
maxClockSpeed |
Output only. The max CPU clock speed in kHz. |
keylockerSupported |
Output only. Whether keylocker is supported. |
keylockerConfigured |
Output only. Whether keylocker is configured. |
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 ( |
Fields | |
---|---|
reportTime |
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: |
sampleFrequency |
Output only. Frequency the report is sampled. A duration in seconds with up to nine fractional digits, ending with ' |
cpuUtilizationPct |
Output only. Sample of CPU utilization (0-100 percent). |
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 |
Output only. CPU temperature in Celsius. |
label |
Output only. CPU label. Example: Core 0 |
MemoryInfo
Memory information of a device.
- This field has both telemetry and device information:
totalRamBytes
- Device informationavailableRamBytes
- Telemetry informationtotalMemoryEncryption
- Device information
- Data for this field is controlled via policy: ReportDeviceMemoryInfo
- Data Collection Frequency:
totalRamBytes
- Only at uploadavailableRamBytes
- Every 10 minutestotalMemoryEncryption
- at device startup
- Default Data Reporting Frequency:
totalRamBytes
- 3 hoursavailableRamBytes
- 3 hourstotalMemoryEncryption
- 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 ( |
Fields | |
---|---|
totalRamBytes |
Output only. Total RAM in bytes. |
availableRamBytes |
Output only. Amount of available RAM in bytes. |
totalMemoryEncryption |
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 ( |
Fields | |
---|---|
encryptionState |
The state of memory encryption on the device. |
maxKeys |
The maximum number of keys that can be used for encryption. |
keyLength |
The length of the encryption keys. |
encryptionAlgorithm |
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 |
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: |
sampleFrequency |
Output only. Frequency the report is sampled. A duration in seconds with up to nine fractional digits, ending with ' |
systemRamFreeBytes |
Output only. Amount of free RAM in bytes (unreliable due to Garbage Collection). |
pageFaults |
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 ( |
Fields | |
---|---|
networkDevices[] |
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 ( |
Fields | |
---|---|
type |
Output only. Network device type. |
macAddress |
Output only. MAC address (if applicable) of the corresponding network device. |
meid |
Output only. MEID (if applicable) of the corresponding network device. |
imei |
Output only. IMEI (if applicable) of the corresponding network device. |
iccid |
Output only. The integrated circuit card ID associated with the device's sim card. |
mdn |
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 ( |
Fields | |
---|---|
reportTime |
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: |
sampleFrequency |
Output only. Frequency the report is sampled. A duration in seconds with up to nine fractional digits, ending with ' |
signalStrengthDbm |
Output only. Signal strength for wireless networks measured in decibels. |
lanIpAddress |
Output only. LAN IP address. |
gatewayIpAddress |
Output only. Gateway IP address. |
transmissionBitRateMbps |
Output only. Transmission bit rate measured in Megabits per second. |
receivingBitRateMbps |
Output only. Receiving bit rate measured in Megabits per second. |
transmissionPowerDbm |
Output only. Transmission power measured in decibels. |
encryptionOn |
Output only. Whether the wifi encryption key is turned off. |
wifiLinkQuality |
Output only. Wifi link quality. Value ranges from [0, 70]. 0 indicates no signal and 70 indicates a strong signal. |
wifiPowerManagementEnabled |
Output only. Wifi power management enabled |
guid |
Output only. Network connection guid. |
connectionState |
Output only. Current connection state of the network. |
connectionType |
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 ( |
Fields | |
---|---|
reportTime |
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: |
httpsLatencyData |
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 ( |
Fields | |
---|---|
updateState |
Output only. Current state of the os update. |
newPlatformVersion |
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 |
Output only. New requested platform version from the pending updated kiosk app. |
lastUpdateTime |
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: |
lastUpdateCheckTime |
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: |
lastRebootTime |
Output only. Timestamp of the last reboot. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
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 ( |
Fields | |
---|---|
adapterInfo |
Output only. Information about the graphics adapter (GPU). |
eprivacySupported |
Output only. Is ePrivacy screen supported or not. |
displayDevices[] |
Output only. Information about the display(s) of the device. |
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 |
Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2). |
driverVersion |
Output only. Version of the GPU driver. |
deviceId |
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 |
Output only. Display device name. |
displayWidthMm |
Output only. Display width in millimeters. |
displayHeightMm |
Output only. Display height in millimeters. |
internal |
Output only. Is display internal or not. |
manufacturerId |
Output only. Three letter manufacturer ID. |
modelId |
Output only. Manufacturer product code. |
manufactureYear |
Output only. Year of manufacture. |
TouchScreenInfo
Information on the device touch screen.
JSON representation |
---|
{
"touchpadLibrary": string,
"devices": [
{
object ( |
Fields | |
---|---|
touchpadLibrary |
Output only. Touchpad library name used by the input stack. |
devices[] |
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 |
Output only. Touch screen device display name. |
touchPointCount |
Output only. Number of touch points supported on the device. |
stylusCapable |
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 ( |
Fields | |
---|---|
reportTime |
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: |
displays[] |
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 |
Output only. Represents the graphics card device id. |
resolutionWidth |
Output only. Resolution width in pixels. |
resolutionHeight |
Output only. Resolution height in pixels. |
refreshRate |
Output only. Refresh rate in Hz. |
isInternal |
Output only. Indicates if display is internal or not. |
displayName |
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 ( |
Fields | |
---|---|
serialNumber |
Output only. Battery serial number. |
manufacturer |
Output only. Battery manufacturer. |
designCapacity |
Output only. Design capacity (mAmpere-hours). |
designMinVoltage |
Output only. Designed minimum output voltage (mV) |
manufactureDate |
Output only. The date the battery was manufactured. |
technology |
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 ( |
Fields | |
---|---|
reportTime |
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: |
serialNumber |
Output only. Battery serial number. |
sample[] |
Output only. Sampling data for the battery sorted in a decreasing order of |
batteryHealth |
Output only. Battery health. |
fullChargeCapacity |
Output only. Full charge capacity (mAmpere-hours). |
cycleCount |
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 |
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: |
voltage |
Output only. Battery voltage (millivolt). |
remainingCapacity |
Output only. Battery remaining capacity (mAmpere-hours). |
temperature |
Output only. Temperature in Celsius degrees. |
dischargeRate |
Output only. The battery discharge rate measured in mW. Positive if the battery is being discharged, negative if it's being charged. |
chargeRate |
Output only. Battery charge percentage. |
current |
Output only. Battery current (mA). |
status |
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 ( |
Fields | |
---|---|
volume[] |
Information for disk volumes |
availableDiskBytes |
The available space for user data storage in the device in bytes. |
totalDiskBytes |
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 |
Disk volume id. |
storageFreeBytes |
Free storage space in bytes. |
storageTotalBytes |
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 ( |
Fields | |
---|---|
reportTime |
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: |
disk[] |
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 |
Output only. Disk serial number. |
manufacturer |
Output only. Disk manufacturer. |
model |
Output only. Disk model. |
sizeBytes |
Output only. Disk size. |
type |
Output only. Disk type: eMMC / NVMe / ATA / SCSI. |
health |
Output only. Disk health. |
volumeIds[] |
Output only. Disk volumes. |
bytesReadThisSession |
Output only. Number of bytes read since last boot. |
bytesWrittenThisSession |
Output only. Number of bytes written since last boot. |
readTimeThisSession |
Output only. Time spent reading from disk since last boot. A duration in seconds with up to nine fractional digits, ending with ' |
writeTimeThisSession |
Output only. Time spent writing to disk since last boot. A duration in seconds with up to nine fractional digits, ending with ' |
ioTimeThisSession |
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 ' |
discardTimeThisSession |
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 ' |
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 ( |
Fields | |
---|---|
securityLevel |
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 ( |
Fields | |
---|---|
bootUpDuration |
Total time to boot up. A duration in seconds with up to nine fractional digits, ending with ' |
bootUpTime |
The timestamp when power came on. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
shutdownDuration |
Total time since shutdown start to power off. A duration in seconds with up to nine fractional digits, ending with ' |
shutdownTime |
The timestamp when shutdown. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
shutdownReason |
The shutdown reason. |
reportTime |
Timestamp when the report was collected. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
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 ( |
Fields | |
---|---|
reportTime |
Timestamp of when status changed was detected A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
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 |
Timestamp of when report was collected A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
appId |
App id of kiosk app for example "mdmkkicfmmkgmpkmkdikhlbggogpicma" |
appVersion |
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 |
Timestamp when the report was collected. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
uptimeRuntimeDuration |
Total lifetime runtime. Currently always S0 runtime from Intel vPro PSR. A duration in seconds with up to nine fractional digits, ending with ' |
enterSleepCount |
Number of times that the device has entered into the sleep state. Currently obtained via the PSR, count from S0->S3. |
enterHibernationCount |
Number of times that the device has entered into the hibernation state. Currently obtained via the PSR, count from S0->S4. |
enterPoweroffCount |
Number of times that the device has entered into the power-off state. Currently obtained via the PSR, count from S0->S5. |
Methods |
|
---|---|
|
Get telemetry device. |
|
List all telemetry devices. |