Aggregate HealthScore (v2.1)

POST 
/v2.1/api/tenants/:tenant_id/monitor/aggregates/healthscore

HealthScore Aggregate categorized as poor, fair and good for MSP and its clients

Request

Path Parameters

tenant_id stringrequired

MSP Tenant Id

application/json

Body

Filters for Aggregate HealthScore

aggregation stringrequired

Possible values: [min, max, avg]

The aggregate value of the health score query.

clients string[]

Clients

end_time date

The end time to get the health score.

healthscore_type stringrequired

Possible values: [Site, Circuit, AnynetLink]

The health score type.

name string

The description of the health score request. Maz size = 128.

start_time date

The start time to get the health score query.

Responses

200

Successful Operation

application/json

Schema

Schema

aggregation string

Possible values: [min, max, avg]

The aggregate value of the health score query.

end_time string

The end time to get the health score.

healthscore_type string

Possible values: [Site, Circuit, AnynetLink]

The health score type.

items LqmStatsHealthScoreAggregateData[]
The values of the filter.
Array [
count int32
The number of LQM Health Scores.
data LqmStatsClientHealthScoreAggregateData[]
The tenant's LQM health score.
Array [
tenant_id string
The tenant ID.
value int32
The LQM stats health score.
]
health string
Possible values: [others, poor, fair, good]
The health values.
]
start_time string

The start time to get the health score query.

Example (from schema)

{
  "aggregation": "min",
  "end_time": "string",
  "healthscore_type": "Site",
  "items": [
    {
      "count": 0,
      "data": [
        {
          "tenant_id": "string",
          "value": 0
        }
      ],
      "health": "others"
    }
  ],
  "start_time": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "AGGREGATION_REQUIRED"
      },
      {
        "code": "HEALTHSCORE_TYPE_REQUIRED"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      }
    ]
  }
}

Loading...