REST Resource: customers.telemetry.users

Resource: TelemetryUser

Telemetry data collected from a managed user.

  • Granular permission needed: TELEMETRY_API_USER
JSON representation 
{
  "name": string,
  "customer": string,
  "orgUnitId": string,
  "userId": string,
  "userEmail": string,
  "userDevice": [
    {
      object (TelemetryUserDevice)
    }
  ]
}
Fields
name

string

Resource name of the user.
customer

string

G Suite Customer whose enterprise enrolled the device.
orgUnitId

string

Organization unit of the user.
userId

string

Directory ID of the user.
userEmail

string

Email address of the user.
userDevice[]

object (TelemetryUserDevice)

Telemetry data collected from a managed user and device.

TelemetryUserDevice

Telemetry data collected for a managed user and device.

  • Granular permission needed: TELEMETRY_API_DEVICE
JSON representation 
{
  "deviceId": string,
  "audioStatusReport": [
    {
      object (AudioStatusReport)
    }
  ],
  "deviceActivityReport": [
    {
      object (DeviceActivityReport)
    }
  ],
  "networkBandwidthReport": [
    {
      object (NetworkBandwidthReport)
    }
  ],
  "peripheralsReport": [
    {
      object (PeripheralsReport)
    }
  ]
}
Fields
deviceId

string

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.
audioStatusReport[]

object (AudioStatusReport)

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

object (DeviceActivityReport)

Output only. Device activity reports collected periodically sorted in a decreasing order of reportTime.
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.

DeviceActivityReport

Device activity report.

  • Granular permission needed: TELEMETRY_API_DEVICE_ACTIVITY_REPORT
JSON representation 
{
  "reportTime": string,
  "deviceActivityState": enum (DeviceActivityState)
}
Fields
reportTime

string (Timestamp format)

Output only. Timestamp of 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".
deviceActivityState

enum (DeviceActivityState)

Output only. Device activity state.

DeviceActivityState

Activity state of the device.

Enums
DEVICE_ACTIVITY_STATE_UNSPECIFIED Device activity state is unspecified.
ACTIVE Device is currently being used.
IDLE Device is currently idle.
LOCKED Device is currently locked.

Methods

get

 Get telemetry user.

list

 List all telemetry users.