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
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
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 over which you want to retrieve metrics, provided in readable format:
last_
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.
Default value: true
Selects which fields to include in the query. Must use the format field
The following operators are supported: >=, <=, ==, !=, >, <
See
About Autonomous DEM API Filter Parameter for details.
Comma-separated list of values that identify additional properties to include in the response. See About Autonomous DEM API Include Parameter for details.
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
Possible values: [muAgent
, rnAgent
]
Selects the endpoint type. See About Autonomous DEM API Endpoint-type Parameter for details.
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.
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.
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
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.
Header Parameters
Used to specify a specific tenant.
This is an optional parameter. Specifies a sub-tenant of the Prisma-Tenant, if any.
Responses
- 200
- 400
- 401
- 500
Summary of agent scores
- application/json
- Schema
- Example (from schema)
Schema
- ScoreSummary
- ScoreSeries
- ScoreSummaryCollection
- ScoreSeriesCollection
- ScoreDistributionCollection
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
agentProperties object
Public IP Adress of the agent
endpoint device ASN (derived from public IP)
endpoint device ASN ORG (derived from public IP)
endpoint device city (derived from public IP)
endpoint device computer name
endpoint device country (derived from public IP)
average CPU (float)
maximum CPU (float)
minimum CPU (float)
disks object[]
disk name
disk queue length average
maximum disk queue length
minimum disk queue length
disk space used, percentage
endpoint device version
Global Protect location
Global Protect tunnel status
Global Protect version
gpGateway object[]
GP tunnel location change time
GP tunnel location change value e.g. US West
gpTunnelStatus object[]
GP tunnel status change time
GP tunnel status change value e.g connected, disconnected
internet connectivity change notifications
internetConnectivityNotificationArray object[]
internet connectivity
internet connectivity disposition (1=enabled,2=disabled,3=enabled+acknowledged
internet connectivity change time
endpoint device latitude (derived from public IP)
endpoint device longitude (derived from public IP)
endpoint device computer model
IP Adress of the MU gateway to which the agent connects
endpoint device operating system name
endpoint device operating system version
average RAM (float)
maximum RAM (float)
minimum RAM (float)
sample time (Unix timestamp)
self serve config enabled
self serve user enabled
system cpu or memory change notifications
systemCpuMemoryNotificationArray object[]
cpu threshold, percent
cpu usage, percent
system memory or cpu disposition (1=enabled,2=disabled,3=enabled+acknowledged
system memory threshold, percent
system memory usage, percent
system memory or cpu change time
system cpu change notifications
systemCpuNotificationArray object[]
CPU disposition (1=enabled,2=disabled,3=enabled+acknowledged
CPU threshold, percent
CPU change time
CPU usage, percent
system memory change notifications
systemMemoryNotificationArray object[]
system memory disposition (1=enabled,2=disabled,3=enabled+acknowledged
system memory threshold, percent
system memory change time
system memory usage, percent
topCpuProcesses object[]
command name
command CPU usage, percent
command RAM usage, percent
topMemoryProcesses object[]
command name
command CPU usage, percent
command RAM usage, percent
total notifications
Global Protect username
wireless LAN connectivity change notifications
wifiConnectivityNotificationArray object[]
wireless LAN connectivity
wireless LAN connectivity disposition (1=enabled,2=disabled,3=enabled+acknowledged
wireless LAN connectivity change time
wireless LAN quality notifications
wifiLinkQualityNotificationArray object[]
wireless LAN quality disposition (1=enabled,2=disabled,3=enabled+acknowledged
wireless LAN link quality value
wireless LAN link quality SSID
wireless LAN link quality threshold
wireless LAN link quality change time
wireless LAN SSID change notifications
wifiSsidChangeNotificationArray object[]
wireless LAN quality current value
wireless LAN SSID current value
wireless LAN SSID disposition (1=enabled,2=disabled,3=enabled+acknowledged
wireless LAN quality previous value
wireless LAN SSID previous value
wireless LAN quality threshold
wireless LAN SSID change time
wlans object[]
wireless LAN BSSID, e.g 70:4f:57:74:72:d2
wireless LAN channel e.g 36
wireless LAN MAC address, e.g 8c:85:90:58:15:98
maximum wireless LAN quality, 0 - 100
maximum wireless LAN received bytes
maximum wireless LAN sent bytes
minimum wireless LAN quality, 0 - 100
minimum wireless LAN received bytes
minimum wireless LAN sent bytes
wireless LAN PHY mode e.g. 802.11ac
wireless LAN quality, 0 - 100
wireless LAN received bytes
wireless LAN SSID, e.g TP-LINK_72D1_5G
maximum wireless LAN sent bytes
average object
application score, 0 - 100
endpoint device score (memory, cpu, disk), 0 - 100
internet score, 0 - 100
local network score, 0 - 100
overlay score (tunnel), 0 - 100
underlay score (tunnel endpoint), 0 - 100
wireless network score, 0 - 100
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
entityCounts object
count of distinct endpoints
count of distinct locations
count of distinct sites
count of distinct application tests
count of distinct users
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample start time (Unix timestamp)
array of tenant service groups
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample period in seconds
series object[]
application score, 0 - 100
endpoint device score (memory, cpu, disk), 0 - 100
internet score, 0 - 100
local network score, 0 - 100
overlay score (tunnel), 0 - 100
underlay score (tunnel endpoint), 0 - 100
wireless network score, 0 - 100
seriesEntityCount object[]
count of distinct endpoints
count of distinct locations
sample time (Unix timestamp)
count of distinct sites
count of distinct application tests
count of distinct users
sample start time (Unix timestamp)
array of tenant service groups
collection object[]
agentProperties object
Public IP Adress of the agent
endpoint device ASN (derived from public IP)
endpoint device ASN ORG (derived from public IP)
endpoint device city (derived from public IP)
endpoint device computer name
endpoint device country (derived from public IP)
average CPU (float)
maximum CPU (float)
minimum CPU (float)
disks object[]
disk name
disk queue length average
maximum disk queue length
minimum disk queue length
disk space used, percentage
endpoint device version
Global Protect location
Global Protect tunnel status
Global Protect version
gpGateway object[]
GP tunnel location change time
GP tunnel location change value e.g. US West
gpTunnelStatus object[]
GP tunnel status change time
GP tunnel status change value e.g connected, disconnected
internet connectivity change notifications
internetConnectivityNotificationArray object[]
internet connectivity
internet connectivity disposition (1=enabled,2=disabled,3=enabled+acknowledged
internet connectivity change time
endpoint device latitude (derived from public IP)
endpoint device longitude (derived from public IP)
endpoint device computer model
IP Adress of the MU gateway to which the agent connects
endpoint device operating system name
endpoint device operating system version
average RAM (float)
maximum RAM (float)
minimum RAM (float)
sample time (Unix timestamp)
self serve config enabled
self serve user enabled
system cpu or memory change notifications
systemCpuMemoryNotificationArray object[]
cpu threshold, percent
cpu usage, percent
system memory or cpu disposition (1=enabled,2=disabled,3=enabled+acknowledged
system memory threshold, percent
system memory usage, percent
system memory or cpu change time
system cpu change notifications
systemCpuNotificationArray object[]
CPU disposition (1=enabled,2=disabled,3=enabled+acknowledged
CPU threshold, percent
CPU change time
CPU usage, percent
system memory change notifications
systemMemoryNotificationArray object[]
system memory disposition (1=enabled,2=disabled,3=enabled+acknowledged
system memory threshold, percent
system memory change time
system memory usage, percent
topCpuProcesses object[]
command name
command CPU usage, percent
command RAM usage, percent
topMemoryProcesses object[]
command name
command CPU usage, percent
command RAM usage, percent
total notifications
Global Protect username
wireless LAN connectivity change notifications
wifiConnectivityNotificationArray object[]
wireless LAN connectivity
wireless LAN connectivity disposition (1=enabled,2=disabled,3=enabled+acknowledged
wireless LAN connectivity change time
wireless LAN quality notifications
wifiLinkQualityNotificationArray object[]
wireless LAN quality disposition (1=enabled,2=disabled,3=enabled+acknowledged
wireless LAN link quality value
wireless LAN link quality SSID
wireless LAN link quality threshold
wireless LAN link quality change time
wireless LAN SSID change notifications
wifiSsidChangeNotificationArray object[]
wireless LAN quality current value
wireless LAN SSID current value
wireless LAN SSID disposition (1=enabled,2=disabled,3=enabled+acknowledged
wireless LAN quality previous value
wireless LAN SSID previous value
wireless LAN quality threshold
wireless LAN SSID change time
wlans object[]
wireless LAN BSSID, e.g 70:4f:57:74:72:d2
wireless LAN channel e.g 36
wireless LAN MAC address, e.g 8c:85:90:58:15:98
maximum wireless LAN quality, 0 - 100
maximum wireless LAN received bytes
maximum wireless LAN sent bytes
minimum wireless LAN quality, 0 - 100
minimum wireless LAN received bytes
minimum wireless LAN sent bytes
wireless LAN PHY mode e.g. 802.11ac
wireless LAN quality, 0 - 100
wireless LAN received bytes
wireless LAN SSID, e.g TP-LINK_72D1_5G
maximum wireless LAN sent bytes
average object
application score, 0 - 100
endpoint device score (memory, cpu, disk), 0 - 100
internet score, 0 - 100
local network score, 0 - 100
overlay score (tunnel), 0 - 100
underlay score (tunnel endpoint), 0 - 100
wireless network score, 0 - 100
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
entityCounts object
count of distinct endpoints
count of distinct locations
count of distinct sites
count of distinct application tests
count of distinct users
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample start time (Unix timestamp)
array of tenant service groups
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample start time (Unix timestamp)
array of tenant service groups
collection object[]
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample period in seconds
series object[]
application score, 0 - 100
endpoint device score (memory, cpu, disk), 0 - 100
internet score, 0 - 100
local network score, 0 - 100
overlay score (tunnel), 0 - 100
underlay score (tunnel endpoint), 0 - 100
wireless network score, 0 - 100
seriesEntityCount object[]
count of distinct endpoints
count of distinct locations
sample time (Unix timestamp)
count of distinct sites
count of distinct application tests
count of distinct users
sample start time (Unix timestamp)
array of tenant service groups
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample period in seconds
sample start time (Unix timestamp)
array of tenant service groups
score classifier e.g. poor:[0 - 30],fair:[30 - 70],good:[70 - 100]
collection object[]
score classifier e.g. poor:[0 - 30],fair:[30 - 70],good:[70 - 100]
distribution object
count of distribution entity e.g. application tests, endpoints
count of scores classified as fair
count of scores classified as good
count of scores classified as poor
average of all scores in distribution
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
entityCounts object
count of distinct endpoints
count of distinct locations
count of distinct sites
count of distinct application tests
count of distinct users
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample start time (Unix timestamp)
array of tenant service groups
sample end time (Unix timestamp)
endpoint type : muAgent, muProbe, rnAgent, rnProbe
entityCounts object
count of distinct endpoints
count of distinct locations
count of distinct sites
count of distinct application tests
count of distinct users
pagination object
page limit
page number
sort by field
sort order : asc, desc
sample start time (Unix timestamp)
array of tenant service groups
{}
Invalid Request
Invalid Client
Server Error