Skip to main content

Get agent scores

GET 
/adem/telemetry/v2/measure/agent/score

Retrieves the summary of the Mobile User agent and Remote Networks agent experience scores, grouped by one or more Mobile User agent entities such as user, endpoint, and location. For example, user or endpoint. For Mobile User agents an endpoint is a UUID that uniquely identifies the end device. To filter by endpoint, use agent_uuid.

Request​

Query Parameters

    start int64

    Possible values: <= 2147483648

    The start time (unix epoch) of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646252520

    end int64

    Possible values: <= 2147483648

    The end time of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646263320

    timerange string

    Timerange over which you want to retrieve metrics, provided in readable format:

    last__<minute|hour|day|week|month>

    The responses are aggregated over a sample period which is a function of the time interval requested, such that the granularity decreases with increasing interval. See About Autonomous DEM API Timerange Parameter for details.

    truncate-timerange boolean

    Default value: true

    filter string

    Selects which fields to include in the query. Must use the format fieldvalue.
    The following operators are supported: >=, <=, ==, !=, >, < See About Autonomous DEM API Filter Parameter for details.

    include string

    Comma-separated list of values that identify additional properties to include in the response. See About Autonomous DEM API Include Parameter for details.

    group string

    The entity by which to group the results. You can use entities such as endpoint, location, site, user, or test. You can specify multiple groups as a comma-separated list. For example, group=Entity.user, group=Entity.test,Entity.location

    endpoint-type stringrequired

    Possible values: [muAgent, rnAgent]

    Selects the endpoint type. See About Autonomous DEM API Endpoint-type Parameter for details.

    result-filter string[]

    Limits results by filtering the output of the query, and maps to a HAVING statement (as compared with the input, which maps to a SELECT statement). Use the format, Score.==,..; For example, to limit score results by category, use Score.endpointScore==fair,good or Score.application==good;Score.lan==fair,good. See About Autonomous DEM API Result-filter Parameter for details.

    response-type stringrequired

    Possible values: [timeseries, summary, distribution, grouped-summary, grouped-timeseries]

    Specifies the response type, such as 'timeseries' or 'group-summary'. See About Autonomous DEM API Response-Type Parameter for details.

    pagination string

    Limits the number of results in the response. It is used when the response-type is grouped-summary. See About Autonomous DEM API Pagination Parameter for details

    distribution-by string

    Gets a distribution of aggregated agent scores, classified as good (> 70), fair (30 - 70) or poor ( < 30). The default grouping is by endpoint - this can be overridden with the distribution-by parameter, in the format en.. Valid options are 'user' and 'location'

Header Parameters

    Prisma-Tenant stringrequired

    Used to specify a specific tenant.

    Prisma-SubTenant string

    This is an optional parameter. Specifies a sub-tenant of the Prisma-Tenant, if any.

Responses​

Summary of agent scores

Schema
    oneOf
    agentProperties object
    agentPublicIp string

    Public IP Adress of the agent

    asn number

    endpoint device ASN (derived from public IP)

    asnOrgName string

    endpoint device ASN ORG (derived from public IP)

    batteryCharge number
    batteryIsCharging number
    batterySaver number
    city string

    endpoint device city (derived from public IP)

    computerName string

    endpoint device computer name

    country string

    endpoint device country (derived from public IP)

    cpuAverage number

    average CPU (float)

    cpuMax number

    maximum CPU (float)

    cpuMin number

    minimum CPU (float)

    deviceCount number
    disks object[]
  • Array [
    • name string

    disk name

    queueLengthAverage number

    disk queue length average

    queueLengthMax number

    maximum disk queue length

    queueLengthMin number

    minimum disk queue length

    spaceUsed number

    disk space used, percentage

  • ]
    • endpointVersion string

    endpoint device version

    globalProtectGatewayLocation string

    Global Protect location

    globalProtectTunnelStatus string

    Global Protect tunnel status

    globalProtectVersion string

    Global Protect version

    gpGateway object[]
  • Array [
    • startTime number

    GP tunnel location change time

    value string

    GP tunnel location change value e.g. US West

  • ]
    • gpTunnelStatus object[]
  • Array [
    • startTime number

    GP tunnel status change time

    value string

    GP tunnel status change value e.g connected, disconnected

  • ]
    • internetConnectivityNotification number

    internet connectivity change notifications

    internetConnectivityNotificationArray object[]
  • Array [
    • connected boolean

    internet connectivity

    disposition number

    internet connectivity disposition (1=enabled,2=disabled,3=enabled+acknowledged

    time number

    internet connectivity change time

  • ]
    • latitude number

    endpoint device latitude (derived from public IP)

    longitude number

    endpoint device longitude (derived from public IP)

    model string

    endpoint device computer model

    muGatewayPublicIp string

    IP Adress of the MU gateway to which the agent connects

    operatingSystem string

    endpoint device operating system name

    operatingSystemVersion string

    endpoint device operating system version

    ramAverage number

    average RAM (float)

    ramMax number

    maximum RAM (float)

    ramMin number

    minimum RAM (float)

    sample number

    sample time (Unix timestamp)

    selfServeConfigEnabled boolean

    self serve config enabled

    selfServeUserEnabled boolean

    self serve user enabled

    systemCpuMemoryNotification number

    system cpu or memory change notifications

    systemCpuMemoryNotificationArray object[]
  • Array [
    • cpuThreshold number

    cpu threshold, percent

    cpuUsage number

    cpu usage, percent

    disposition number

    system memory or cpu disposition (1=enabled,2=disabled,3=enabled+acknowledged

    memoryThreshold number

    system memory threshold, percent

    memoryUsage number

    system memory usage, percent

    time number

    system memory or cpu change time

  • ]
    • systemCpuNotification number

    system cpu change notifications

    systemCpuNotificationArray object[]
  • Array [
    • disposition number

    CPU disposition (1=enabled,2=disabled,3=enabled+acknowledged

    threshold number

    CPU threshold, percent

    time number

    CPU change time

    usage number

    CPU usage, percent

  • ]
    • systemMemoryNotification number

    system memory change notifications

    systemMemoryNotificationArray object[]
  • Array [
    • disposition number

    system memory disposition (1=enabled,2=disabled,3=enabled+acknowledged

    threshold number

    system memory threshold, percent

    time number

    system memory change time

    usage number

    system memory usage, percent

  • ]
    • topCpuProcesses object[]
  • Array [
    • command string

    command name

    cpu number

    command CPU usage, percent

    memory number

    command RAM usage, percent

  • ]
    • topMemoryProcesses object[]
  • Array [
    • command string

    command name

    cpu number

    command CPU usage, percent

    memory number

    command RAM usage, percent

  • ]
    • totalNotifications number

    total notifications

    username string

    Global Protect username

    wifiConnectivityNotification number

    wireless LAN connectivity change notifications

    wifiConnectivityNotificationArray object[]
  • Array [
    • connected boolean

    wireless LAN connectivity

    disposition number

    wireless LAN connectivity disposition (1=enabled,2=disabled,3=enabled+acknowledged

    time number

    wireless LAN connectivity change time

  • ]
    • wifiLinkQualityNotification number

    wireless LAN quality notifications

    wifiLinkQualityNotificationArray object[]
  • Array [
    • disposition number

    wireless LAN quality disposition (1=enabled,2=disabled,3=enabled+acknowledged

    quality number

    wireless LAN link quality value

    ssid string

    wireless LAN link quality SSID

    threshold number

    wireless LAN link quality threshold

    time number

    wireless LAN link quality change time

  • ]
    • wifiSsidChangeNotification number

    wireless LAN SSID change notifications

    wifiSsidChangeNotificationArray object[]
  • Array [
    • currentQuality number

    wireless LAN quality current value

    currentSsid string

    wireless LAN SSID current value

    disposition number

    wireless LAN SSID disposition (1=enabled,2=disabled,3=enabled+acknowledged

    previousQuality number

    wireless LAN quality previous value

    previousSsid string

    wireless LAN SSID previous value

    threshold number

    wireless LAN quality threshold

    time number

    wireless LAN SSID change time

  • ]
    • wlans object[]
  • Array [
    • bssid string

    wireless LAN BSSID, e.g 70:4f:57:74:72:d2

    channel string

    wireless LAN channel e.g 36

    macAddress string

    wireless LAN MAC address, e.g 8c:85:90:58:15:98

    maxQuality number

    maximum wireless LAN quality, 0 - 100

    maxRx number

    maximum wireless LAN received bytes

    maxtx number

    maximum wireless LAN sent bytes

    minQuality number

    minimum wireless LAN quality, 0 - 100

    minRx number

    minimum wireless LAN received bytes

    minTx number

    minimum wireless LAN sent bytes

    phyMode string

    wireless LAN PHY mode e.g. 802.11ac

    quality number

    wireless LAN quality, 0 - 100

    rx number

    wireless LAN received bytes

    ssid string

    wireless LAN SSID, e.g TP-LINK_72D1_5G

    tx number

    maximum wireless LAN sent bytes

  • ]
    • average object
    application number

    application score, 0 - 100

    endpointScore number

    endpoint device score (memory, cpu, disk), 0 - 100

    internet number

    internet score, 0 - 100

    lan number

    local network score, 0 - 100

    sample number
    vpnOverlay number

    overlay score (tunnel), 0 - 100

    vpnUnderlay number

    underlay score (tunnel endpoint), 0 - 100

    wlan number

    wireless network score, 0 - 100

    endTime number

    sample end time (Unix timestamp)

    endpointType string

    endpoint type : muAgent, muProbe, rnAgent, rnProbe

    entityCounts object
    endpoint number

    count of distinct endpoints

    location number

    count of distinct locations

    site number

    count of distinct sites

    test number

    count of distinct application tests

    user number

    count of distinct users

    id stringrequired
    pagination object
    enabled boolean
    limit number

    page limit

    page number

    page number

    sortBy string

    sort by field

    sortOrder string

    sort order : asc, desc

    rowCount number
    startTime number

    sample start time (Unix timestamp)

    tenantServiceGroup string

    array of tenant service groups

Loading...