REST API for Unified Assurance Core

Get Metrics for a Device

get

/api/metric/NetworkTraffic

Get the metrics for a specified device that match the specified query parameters. If no optional query parameters are specified, all metrics for the device are returned.

Request

Query Parameters

DeviceName(required): string
The composite name of the device to get metrics for. Based on custom name, DNS name, sys name, and IP addresses.
Example:
```
router.example.com
```
DeviceZoneName(required): string
The zone name of the device to get metrics for.
Example:
```
Oracle Lab - Network Equipment
```
TimeRange(required): string
A shorthand string that encompasses StartTime and StopTime. Ignored if StartTime is specified. Default to the last 24 hours if no value is provided.
Example:
```
now-24h..now
```

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

group: object

The group parameter. It groups results by field and direction.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}

direction(required): string

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

The direction of the group.

Example: ASC
property(required): string

The field name to group by.

Example: name

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

limit: integer(int32)
The number of records to limit results by.
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"
}

start: integer(int32)
The page of results to start from.

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
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":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricNetworkTrafficRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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
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":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricNetworkTrafficRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object metricNetworkTrafficRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricNetworkTrafficRead"
    }
}

Nested Schema : metricNetworkTrafficRead

Type: object

Show Source

Abbr: string

Metric Abbreviation

Example: s
DeviceID: string

Device ID specified for view of metrics. It can be a single value or a comma-separated list of ID's

Example: 1555
DeviceName: string

Device Name

Example: router.example.com
DeviceZoneID: integer

DeviceZone ID to indicate which devices to include

Example: 9
Direction: integer

Direction

Example: 0
Factor: integer

Factor

Example: 1
IfSpeed: string

IfSpeed

Example: oracle.doceng.json.BetterJsonNull@61d87509
InboundAvailability: number

Inbound Availability

Example: 100
InboundAverageUtilization: number

Inbound Average Utilization

Example: oracle.doceng.json.BetterJsonNull@74c997b1
InboundAverageValue: number

Inbound Average Value

Example: 7.496613939244192E-4
InboundLastUtilization: number

Inbound Last Utilization

Example: oracle.doceng.json.BetterJsonNull@17f8c75e
InboundLastValue: number

Inbound Last Value

Example: 7.76863098144531E-4
InboundMaximumUtilization: number

Inbound Maximum Utilization

Example: oracle.doceng.json.BetterJsonNull@2d7bfb13
InboundMaximumValue: number

Inbound Maximum Value

Example: 0.0022432804107666
InboundMinimumUtilization: number

Inbound Minimum Utilization

Example: oracle.doceng.json.BetterJsonNull@50e0541
InboundMinimumValue: number

Inbound Minimum Value

Example: 3.22437286376953E-4
InboundPeakUtilization: number

Inbound Peak Utilization

Example: oracle.doceng.json.BetterJsonNull@29c471f6
InboundPeakValue: number

Inbound Peak Value

Example: 0.0022432804107666
InboundTrend: number

Inbound Trend

Example: 0
InstanceName: string

Instance Name

Example: Device
Measurement: string

Measurement

Example: metrictype_Latency
MetricGroupID: integer

Metric Group ID specified to limit which metrics are included

Example: 6
MetricID: integer

May be a single value or a comma-separated list

Example: 642677
MetricTypeName: string

Metric Type Name

Example: Latency
OriginalMetricTypeName: string

Original Metric Type Name

Example: Latency
OutboundAvailability: number

Inbound Last Utilization

Example: 0
OutboundAverageUtilization: number

Outbound Average Utilization

Example: 0
OutboundAverageValue: number

Outbound Average Value

Example: 0
OutboundLastUtilization: number

Outbound Last Utilization

Example: 0
OutboundLastValue: integer

Outbound Last Value

Example: 0
OutboundMaximumUtilization: number

Outbound Maximum Utilization

Example: 0
OutboundMaximumValue: number

Outbound Maximum Value

Example: 0
OutboundMinimumUtilization: number

Outbound Minimum Utilization

Example: 0
OutboundMinimumValue: number

Outbound Minimum Value

Example: 0
OutboundPeakUtilization: number

Outbound Peak Utilization

Example: 0
OutboundPeakValue: number

Outbound Peak Value

Example: 0
OutboundTrend: number

Out bound Trend

Example: 0
ParentDeviceID: integer

Parent Device ID

Example: 0
SourceInstanceName: string

Source Instance Name

Example: Device
UnitDivision: integer

Unit Division

Example: 60

{
    "properties":{
        "DeviceID":{
            "description":"Device ID specified for view of metrics. It can be a single value or a comma-separated list of ID's",
            "type":"string",
            "example":"1555"
        },
        "ParentDeviceID":{
            "description":"Parent Device ID",
            "type":"integer",
            "example":"0"
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceZoneID":{
            "description":"DeviceZone ID to indicate which devices to include",
            "type":"integer",
            "example":"9"
        },
        "MetricID":{
            "description":"May be a single value or a comma-separated list",
            "type":"integer",
            "example":642677
        },
        "Factor":{
            "description":"Factor",
            "type":"integer",
            "example":"1"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Latency"
        },
        "OriginalMetricTypeName":{
            "description":"Original Metric Type Name",
            "type":"string",
            "example":"Latency"
        },
        "Measurement":{
            "description":"Measurement",
            "type":"string",
            "example":"metrictype_Latency"
        },
        "Abbr":{
            "description":"Metric Abbreviation",
            "type":"string",
            "example":"s"
        },
        "MetricGroupID":{
            "description":"Metric Group ID specified to limit which metrics are included",
            "type":"integer",
            "example":"6"
        },
        "UnitDivision":{
            "description":"Unit Division",
            "type":"integer",
            "example":"60"
        },
        "Direction":{
            "description":"Direction",
            "type":"integer",
            "example":"0"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"Device"
        },
        "IfSpeed":{
            "description":"IfSpeed",
            "type":"string",
            "example":null
        },
        "InboundAvailability":{
            "description":"Inbound Availability",
            "type":"number",
            "example":100
        },
        "InboundTrend":{
            "description":"Inbound Trend",
            "type":"number",
            "example":"0"
        },
        "InboundMinimumValue":{
            "description":"Inbound Minimum Value",
            "type":"number",
            "example":3.22437286376953E-4
        },
        "InboundMaximumValue":{
            "description":"Inbound Maximum Value",
            "type":"number",
            "example":0.0022432804107666
        },
        "InboundAverageValue":{
            "description":"Inbound Average Value",
            "type":"number",
            "example":7.496613939244192E-4
        },
        "InboundPeakValue":{
            "description":"Inbound Peak Value",
            "type":"number",
            "example":0.0022432804107666
        },
        "InboundLastValue":{
            "description":"Inbound Last Value",
            "type":"number",
            "example":7.76863098144531E-4
        },
        "InboundMinimumUtilization":{
            "description":"Inbound Minimum Utilization",
            "type":"number",
            "example":null,
            "nullable":true
        },
        "InboundMaximumUtilization":{
            "description":"Inbound Maximum Utilization",
            "type":"number",
            "example":null,
            "nullable":true
        },
        "InboundAverageUtilization":{
            "description":"Inbound Average Utilization",
            "type":"number",
            "example":null,
            "nullable":true
        },
        "InboundPeakUtilization":{
            "description":"Inbound Peak Utilization",
            "type":"number",
            "example":null,
            "nullable":true
        },
        "InboundLastUtilization":{
            "description":"Inbound Last Utilization",
            "type":"number",
            "example":null,
            "nullable":true
        },
        "OutboundAvailability":{
            "description":"Inbound Last Utilization",
            "type":"number",
            "example":"0"
        },
        "OutboundTrend":{
            "description":"Out bound Trend",
            "type":"number",
            "example":"0"
        },
        "OutboundMinimumValue":{
            "description":"Outbound Minimum Value",
            "type":"number",
            "example":"0"
        },
        "OutboundMaximumValue":{
            "description":"Outbound Maximum Value",
            "type":"number",
            "example":"0"
        },
        "OutboundAverageValue":{
            "description":"Outbound Average Value",
            "type":"number",
            "example":"0"
        },
        "OutboundPeakValue":{
            "description":"Outbound Peak Value",
            "type":"number",
            "example":"0"
        },
        "OutboundLastValue":{
            "description":"Outbound Last Value",
            "type":"integer",
            "example":"0"
        },
        "OutboundMinimumUtilization":{
            "description":"Outbound Minimum Utilization",
            "type":"number",
            "example":"0"
        },
        "OutboundMaximumUtilization":{
            "description":"Outbound Maximum Utilization",
            "type":"number",
            "example":"0"
        },
        "OutboundAverageUtilization":{
            "description":"Outbound Average Utilization",
            "type":"number",
            "example":"0"
        },
        "OutboundPeakUtilization":{
            "description":"Outbound Peak Utilization",
            "type":"number",
            "example":"0"
        },
        "OutboundLastUtilization":{
            "description":"Outbound Last Utilization",
            "type":"number",
            "example":"0"
        },
        "SourceInstanceName":{
            "description":"Source Instance Name",
            "type":"string",
            "example":"Device"
        }
    },
    "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":{
                "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

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

Nested Schema : items

Type: object