Query Aggregate Health Score (v2.0)
POST/sdwan/v2.0/api/tenants/:esp_tenant_id/monitor/aggregates/healthscore
Query the aggregate health score for MSP and its clients.
Request
Path Parameters
esp_tenant_id stringrequired
ID of the MSP tenant.
- application/json
Body
Filters for Aggregate HealthScore
aggregation stringrequired
Possible values: [min
, max
, avg
]
The aggregate value of the health score query.
end_time daterequired
The end time to get the health score.
healthscore_type stringrequired
Possible values: [Site
, Circuit
, AnynetLink
]
The health score type.
name stringrequired
The description of the health score request. Maz size = 128.
start_time daterequired
The start time to get the health score query.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
aggregation stringrequired
Possible values: [min
, max
, avg
]
The aggregate value of the health score query.
end_time stringrequired
The end time to get the health score.
healthscore_type stringrequired
Possible values: [Site
, Circuit
, AnynetLink
]
The health score type.
items LqmStatsHealthScoreAggregateData[]required
The values of the filter.
count int32required
Count
data LqmStatsClientHealthScoreAggregateData[]required
Data
value int32required
Value
health stringrequired
Possible values: [others
, poor
, fair
, good
]
Health
start_time stringrequired
The start time to get the health score query.
{
"aggregation": "min",
"end_time": "string",
"healthscore_type": "Site",
"items": [
{
"count": 0,
"data": [
{
"value": 0
}
],
"health": "others"
}
],
"start_time": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
code string
message string
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "AGGREGATION_REQUIRED"
},
{
"code": "HEALTHSCORE_TYPE_REQUIRED"
},
{
"code": "START_TIME_GREATER_THAN_END_TIME"
}
]
}
}
Loading...