Query Healthscore Metrics (v2.0)

POST 
/sdwan/v2.0/api/monitor/aiops/health

Get health metrics for sites, links, and applications. Start time need to be specified in ISO8601 UTC format. Metrics need to specified according to 2.0 specifications.

Request

application/json

Body

Query request for getting healthscore metrics

end_time date

The end time to get the healthscore metrics.

filter HealthFilter

Filters according to the specifications.

application_health string[]

Possible values: [POOR, FAIR, GOOD, OTHERS, ALL]

Application Health

link_health string[]

Possible values: [POOR, FAIR, GOOD, OTHERS, ALL]

Link Health

site_health string[]

Possible values: [POOR, FAIR, GOOD, OTHERS, ALL]

Site Health

interval string

Possible values: [10sec, 1min, 5min, 1hour, 1day]

The interval time of the healthscore responses.

name string

The name of the healthscore filter.

start_time date

The start time to get the healthscore metrics.

view string

Possible values: [SUMMARY, TIMESERIES]

View the healthscore metrics.

Responses

200

Successful Operation

application/json

Schema

Schema

data HealthData[]
The details of the health data.
Array [
fair object
Fair
good object
Good
others object
Others
poor object
Poor
total number
Total
type string
Type
]
end_time date

The end time to get the health data.

interval string

Possible values: [10sec, 1min, 5min, 1hour, 1day]

The interval time of the health data response.

start_time date

The start time to get the health data.

view object

View the health score data.

Example (from schema)

{
  "data": [
    {
      "fair": {},
      "good": {},
      "others": {},
      "poor": {},
      "total": 0,
      "type": "string"
    }
  ],
  "end_time": "2024-04-25",
  "interval": "10sec",
  "start_time": "2024-04-25",
  "view": {}
}

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": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "METRIC_NOT_SUPPORTED"
      },
      {
        "code": "FUTURE_TIME_ERROR"
      }
    ]
  }
}

Loading...