Skip to main content

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

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, 1month]

    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

Successful Operation

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, 1month]

    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.

Loading...