REST API for Unified Assurance Core

Get Information About Metrics for Graphs

get

/api/metric/PerformanceData/readMetrics

Gets information about existing metrics that can be graphed.
An example path with query parameters is:

/api/metric/PerformanceData/readMetrics?page=1&start=0&limit=10&sort=%5B%7B%22property%22%3A%22DeviceName%22%2C%22direction%22%3A%22ASC%22%7D%5D

Request

Query Parameters

MetricID:

Match All

string

Metric ID (or multiple, comma-separated Metric IDs)

Example: 154

{
    "allOf":[
        {
            "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID"
        }
    ]
}

filter: object

The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{ "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

Default Value: LIKE

Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

The filter operation to use.

Example: eq
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
Example:
```
100
```

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

Default Value: 0
Example:
```
1
```

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The metric information that can be graphed.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricPerformanceDataReadMetrics"
                    }
                }
            }
        }
    ]
}

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 metric information that can be graphed.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The metric information that can be graphed.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricPerformanceDataReadMetrics"
            }
        }
    }
}

Nested Schema : data

Type: array

The metric information that can be graphed.

Show Source

Array of: object metricPerformanceDataReadMetrics

{
    "description":"The metric information that can be graphed.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricPerformanceDataReadMetrics"
    }
}

Nested Schema : metricPerformanceDataReadMetrics

Type: object

Show Source

DeviceID: string

Device ID (or multiple, comma-separated Device IDs)

Example: 40
DeviceMetricID: string

Device ID and Metric ID concatenated with a hyphen "-"

Example: 40-154
DeviceName: string

The serialized device name (or multiple, comma-separated serialized device names). The device name may be serialized (include the zone id) or just the name if the zone is included separately.

Example: router.example.com OR router.example.com;z1
DeviceZoneName: string

Device zone name

Example: Default First Zone
DisplayInstanceName: string

Metric Display (custom) Instance Name

Example: Device
InstanceName: string

Metric Instance Name

Example: Device
MetricID: string

Metric ID (or multiple, comma-separated Metric IDs)

Example: 154
MetricTypeName: string

Metric Type Name

Example: Latency

{
    "properties":{
        "MetricID":{
            "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID"
        },
        "DeviceID":{
            "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceID"
        },
        "DeviceMetricID":{
            "description":"Device ID and Metric ID concatenated with a hyphen \"-\"",
            "type":"string",
            "example":"40-154"
        },
        "DeviceName":{
            "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName"
        },
        "DeviceZoneName":{
            "description":"Device zone name",
            "type":"string",
            "example":"Default First Zone"
        },
        "MetricTypeName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricTypeName"
        },
        "InstanceName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/InstanceName"
        },
        "DisplayInstanceName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricInstanceName"
        }
    },
    "type":"object"
}

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 examples show how to use query parameters in Get Information About Metrics for Graphs requests.

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

To use the MetricID parameter to return results for a specific metric (154):

http://hostFQDN/api/metric/PerformanceData/readMetrics?MetricID=154

To use the standard pagination query parameters to filter results for all metrics:

http://hostFQDN/api/metric/PerformanceData/readMetrics?page=1&start=0&limit=10&sort=%5B%7B%22property%22%3A%22DeviceName%22%2C%22direction%22%3A%22ASC%22%7D%5D

Example of the Response Body

The following example shows the contents of the response body when filtering by MetricID in JSON format:

{
  "success": "true",
  "message": "Loaded 1 entries",
  "total": "1",
  "data": [
    {
      "DeviceName": "router.example.com",
      "DeviceZoneName": "string",
      "DeviceZoneID": 0,
      "StartTime": "1234567890",
      "StopTime": "1234567890",
      "MetricInstanceName": "Device",
      "ParentDeviceName": "parent.example.com",
      "InstanceName": "Device",
      "MetricTypeName": "Latency",
      "Unit": "bits",
      "Abbr": "b",
      "UnitDivision": "1024",
      "Maximum": "0",
      "MetricID": "1",
      "Factor": "8",
      "PollTime": "300",
      "MetricGroupName": "Network Traffic",
      "Stacked": "0",
      "AverageValue": "1000",
      "MinimumValue": "0",
      "MaximumValue": "5000",
      "SumValue": "300000",
      "LastValue": "1500",
      "PeakValue": "5000",
      "AverageUtilization": "50",
      "MinimumUtilization": "0",
      "MaximumUtilization": "100",
      "LastUtilization": "60",
      "PeakUtilization": "100",
      "TrendSlope": "0.1",
      "retention": "string",
      "navigationRetention": "string",
      "GraphTitle": "Graph Title",
      "Points": [
        [
          {}
        ]
      ],
      "AbnormalPoints": [
        [
          {}
        ]
      ],
      "AbnormalConfidence": [
        [
          {}
        ]
      ],
      "NavigatorPoints": [
        [
          {}
        ]
      ],
      "NavigatorParams": {
        "retention": "string",
        "measurement": "string",
        "zone": "string",
        "device": "string",
        "instance": "string",
        "dbConn": 0
      },
      "TrendPoints": [
        [
          {}
        ]
      ],
      "Threshold": [
        {
          "ThresholdName": "string",
          "ThresholdTypeID": 0,
          "ThresholdType": "string",
          "MetricField": "string",
          "WarningOperator": "string",
          "WarningValue": 0,
          "WarningSeverity": 0,
          "CriticalOperator": "string",
          "CriticalValue": 0,
          "CriticalSeverity": 0
        }
      ]
    }
  ]
}