REST Resource: customers.telemetry.users

    • The TelemetryUser resource provides telemetry data collected from a managed user and their associated devices.

    • The TelemetryUserDevice resource contains various periodic reports about a user's device, including audio status, activity, network bandwidth, peripherals, and applications.

    • The DeviceActivityReport details the device activity state, such as active, idle, or locked, and the timestamp of the report.

    • You can retrieve a specific telemetry user's data using the get method or list all telemetry users using the list method.

    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 
 
) 
 } 
 ] 
 , 
 "appReport" 
 : 
 [ 
 { 
 object (  AppReport 
 
) 
 } 
 ] 
 }
    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 .
    appReport[]

    object ( AppReport )

    Output only. App 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.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: