Get Monitor Metrics (v2.3)

GET 
/sdwan/v2.3/api/monitor/metrics/:mtype

List all the details of the monitor metrics.

Request

Path Parameters

mtype stringrequired

The metric type.

Responses

200

Successful Operation

application/json

Schema

Schema

metrics MetricSchema[]required
The details of the metrics.
Array [
description required
The description of the metric schema. Max size = 256.
name stringrequired
The name of the metric schema. Max size = 126.
statistics string[]required
The metric statistics.
units string[]required
The units of the metrics.
]

Example (from schema)

{
  "metrics": [
    {
      "name": "string",
      "statistics": [
        "string"
      ],
      "units": [
        "string"
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

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

Example

{
  "value": {
    "_error": [
      {
        "code": "METRIC_NOT_SUPPORTED"
      }
    ]
  }
}

Loading...