REST Resource: customers.telemetry.devices

Resource: TelemetryDevice

Telemetry data collected from a managed 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)
    }
  ],
  "networkStatusReport": [
    {
      object (NetworkStatusReport)
    }
  ],
  "osUpdateStatus": [
    {
      object (OsUpdateStatus)
    }
  ],
  "graphicsInfo": {
    object (GraphicsInfo)
  },
  "graphicsStatusReport": [
    {
      object (GraphicsStatusReport)
    }
  ],
  "batteryInfo": [
    {
      object (BatteryInfo)
    }
  ],
  "batteryStatusReport": [
    {
      object (BatteryStatusReport)
    }
  ],
  "storageInfo": {
    object (StorageInfo)
  },
  "storageStatusReport": [
    {
      object (StorageStatusReport)
    }
  ]
}
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 Chrome OS Devices tab

serialNumber

string

Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the Chrome OS Devices tab.

cpuInfo[]

object (CpuInfo)

Output only. Information regarding CPU specs for the device.

cpuStatusReport[]

object (CpuStatusReport)

Output only. CPU status reports collected periodically.

memoryInfo

object (MemoryInfo)

Output only. Information regarding memory specs for the device.

memoryStatusReport[]

object (MemoryStatusReport)

Output only. Memory status reports collected periodically.

networkStatusReport[]

object (NetworkStatusReport)

Output only. Network specs 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.

CpuInfo

CPU specs for a CPU.

JSON representation
{
  "model": string,
  "architecture": enum (Architecture),
  "maxClockSpeed": integer
}
Fields
model

string

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

architecture

enum (Architecture)

Output only. The CPU architecture.

maxClockSpeed

integer

Output only. The max CPU clock speed in kHz.

Architecture

Architechture type for the CPU.

Enums
ARCHITECTURE_UNSPECIFIED Architecture unknown.
X64 x64 architecture

CpuStatusReport

Contains samples of the cpu status reports.

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, terminated by '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

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.

JSON representation
{
  "totalRamBytes": string,
  "availableRamBytes": string
}
Fields
totalRamBytes

string (int64 format)

Output only. Total RAM in bytes.

availableRamBytes

string (int64 format)

Output only. Amount of available RAM in bytes.

MemoryStatusReport

Contains samples of memory status reports.

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, terminated by '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

NetworkStatusReport

State of visible/configured networks.

JSON representation
{
  "reportTime": string,
  "sampleFrequency": string,
  "signalStrengthDbm": integer,
  "lanIpAddress": string,
  "gatewayIpAddress": string
}
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, terminated by '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.

OsUpdateStatus

Contains information regarding the current OS update status.

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.

JSON representation
{
  "adapterInfo": {
    object (GraphicsAdapterInfo)
  }
}
Fields
adapterInfo

object (GraphicsAdapterInfo)

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

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.

GraphicsStatusReport

Information of the graphics subsystem.

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

BatteryInfo

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.

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.

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.

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.

Enums
BATTERY_HEALTH_UNSPECIFIED Health unknown.
BATTERY_HEALTH_NORMAL Battery is healthy.
BATTERY_REPLACE_SOON Battery is moderately unhealthy and should be replaced soon.
BATTERY_REPLACE_NOW Battery is unhealthy and should be replaced.

StorageInfo

Status data for storage.

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.

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, terminated by '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, terminated by '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, terminated by '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, terminated by 's'. Example: "3.5s".

Methods

list

List all telemetry devices.