Get Enterprise Aggregate Health Stats
Fetch aggregate Edge health metrics for all Edges belonging to the target customer
Request
URLURL
https://{api_host}//enterprises/{enterpriseId}/healthStats
Path Parameters
Path Parameters
string
enterpriseId
Required
The `logicalId` GUID for the target enterprise
Query Parameters
Query Parameters
string
include
Optional
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
string
metrics
Optional
This parameter has no documentation
Response
Response
Response BodyResponse Body
200 OK returns
EnterpriseHealthStatsSchema of type application/json
Request successfully processed
{
"_href": "string",
"data": [
{
"cpuPct": 0,
"flowCount": 0,
"handoffQueueDrops": 0,
"memoryPct": 0,
"tunnelCount": 0,
"tunnelCountV6": 0
}
],
"metaData": {
"limit": 0,
"more": false,
"nextPageLink": "string",
"prevPageLink": "string"
}
}
string
_href
Optional
This property has no documentation
data
Optional
This property has no documentation
metaData
Optional
This property has no documentation
cURL Command
curl https://{api_host}/enterprises/{enterpriseId}/healthStats
