REST API for Unified Assurance Core

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

NavigatorParams: array[object]

The information necessary for loading the navigation asynchronously.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The navigator series that matches the query parameters.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "MetricID":{
                                "type":"integer",
                                "description":"The metric ID.",
                                "example":1
                            },
                            "Timestamp":{
                                "type":"integer",
                                "description":"The epoch time value.",
                                "example":"1696324800000"
                            },
                            "Value":{
                                "type":"number",
                                "description":"The navigator value for the given metric at the given time.",
                                "example":"0.000508975982666016"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The navigator series that matches the query parameters.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The navigator series that matches the query parameters.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "MetricID":{
                        "type":"integer",
                        "description":"The metric ID.",
                        "example":1
                    },
                    "Timestamp":{
                        "type":"integer",
                        "description":"The epoch time value.",
                        "example":"1696324800000"
                    },
                    "Value":{
                        "type":"number",
                        "description":"The navigator value for the given metric at the given time.",
                        "example":"0.000508975982666016"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: array

The navigator series that matches the query parameters.

Show Source

Array of: object items

{
    "description":"The navigator series that matches the query parameters.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "MetricID":{
                "type":"integer",
                "description":"The metric ID.",
                "example":1
            },
            "Timestamp":{
                "type":"integer",
                "description":"The epoch time value.",
                "example":"1696324800000"
            },
            "Value":{
                "type":"number",
                "description":"The navigator value for the given metric at the given time.",
                "example":"0.000508975982666016"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

MetricID: integer

The metric ID.

Example: 1
Timestamp: integer

The epoch time value.

Example: 1696324800000
Value: number

The navigator value for the given metric at the given time.

Example: 0.000508975982666016

{
    "type":"object",
    "properties":{
        "MetricID":{
            "type":"integer",
            "description":"The metric ID.",
            "example":1
        },
        "Timestamp":{
            "type":"integer",
            "description":"The epoch time value.",
            "example":"1696324800000"
        },
        "Value":{
            "type":"number",
            "description":"The navigator value for the given metric at the given time.",
            "example":"0.000508975982666016"
        }
    }
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

errors: array errors

The list of errors reported. Validation errors will be keyed by record field.
message: string

The response message.

Example: Exception thrown
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

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
    }
  ]
}