Get a Navigator Series for a Chart Display

get

/api/metric/PerformanceData/readForNavigator

Gets the navigator series that matches the specified parameters for a chart display.
An example path with query parameters is:
/api/metric/PerformanceData/readForNavigator?NavigatorParams=%7B%22264%22%3A%7B%22retention%22%3A%22daily%22%2C%22measurement%22%3A%22metrictype_Latency%22%2C%22zone%22%3A%22zone%20%20%20%20%20%3D%20%20%273%27%22%2C%22device%22%3A%22(%20host%20%3D%20%27router.example.com%27%20OR%20host%20%3D%20%27127:0:0:1%27%20)%22%2C%22instance%22%3A%22Device%22%2C%22dbConn%22%3A%221%22%7D%7D

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The navigator series that matches the query parameters.
Show Source
Nested Schema : items
Type: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top

Examples

The following example shows how to use query parameters in Get a Navigator Series for a Chart Display requests.

You can submit requests using cURL, an API client, or your browser.

http://hostFQDN/api/metric/PerformanceData/readForNavigator?NavigatorParams=%7B%22264%22%3A%7B%22retention%22%3A%22daily%22%2C%22measurement%22%3A%22metrictype_Latency%22%2C%22zone%22%3A%22zone%20%20%20%20%20%3D%20%20%273%27%22%2C%22device%22%3A%22(%20host%20%3D%20%27router.example.com%27%20OR%20host%20%3D%20%27127:0:0:1%27%20)%22%2C%22instance%22%3A%22Device%22%2C%22dbConn%22%3A%221%22%7D%7D

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "success": "true",
  "message": "Loaded 1 entries",
  "data": [
    {
      "MetricID": 1,
      "Timestamp": 1696324800000,
      "Value": 0.000508975982666016
    }
  ]
}
Back to Top