Query Aggregate Health Score (v2.0)

Query the aggregate health score for MSP and its clients.

Path Parameters

• esp_tenant_id string required

  ID of the MSP tenant.

application/json

Request Body

Filters for Aggregate HealthScore

• aggregation string required

  Possible values: [min, max, avg]

  The aggregate value of the health score query.

• end_time date required

  The end time to get the health score.

• healthscore_type string required

  Possible values: [Site, Circuit, AnynetLink]

  The health score type.

• name string required

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

• start_time date required

  The start time to get the health score query.

Responses

• 200
• 400

---

Successful Operation

application/json

• Schema
• Example (from schema)

---

Schema

• aggregation string required

  Possible values: [min, max, avg]

  The aggregate value of the health score query.

• end_time string required

  The end time to get the health score.

• healthscore_type string required

  Possible values: [Site, Circuit, AnynetLink]

  The health score type.

• items LqmStatsHealthScoreAggregateData[] required

  The values of the filter.

  Array [

  count int32 required

  Count

  data LqmStatsClientHealthScoreAggregateData[] required

  Data

  Array [

  value int32 required

  Value

  ]

  health string required

  Possible values: [others, poor, fair, good]

  Health

  ]
• start_time string required

  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

• _error ErrorResponse[]

  Array [

  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...