REST API for Unified Assurance Core

Get Metrics for an Instance

get

/api/metric/AllMetricsOverview

Gets the metrics for the specified instance that match the query parameters.

Request

Query Parameters

DeviceGroup(required): string
The device group. Only used if DeviceSource is set to DeviceGroup.
Example:
```
//Root//Group1
```
DeviceSource(required): string
Which device or devices to include. If no source is set, it assumes a single device. Allowed Values:
- All
- DeviceGroup: Also set the DeviceGroup parameter to the device group name.
- DeviceZone: Also set the DeviceZoneName parameter to the device zone name.
- Device: Also set the id parameter to the device name.
- MultipleDevices: Also set the id parameter to the comma-separated list of device names.
Example:
```
Device
```
DeviceZoneName(required): string
The device zone name. Only used if DeviceSource is set to DeviceZone.
Example:
```
Oracle Lab - Network Equipment
```
ExcludeDisabled(required): boolean

Whether to exclude disabled devices (1) or not (0).
MetricGroup(required): string
The metric group to include. Only used if MetricSource is set to MetricGroup.
Example:
```
Device Health
```
MetricSource(required): string
Which metrics to include. If no source is set, all metrics are included. Allowed Values:
- All
- MetricGroup: Also set the MetricGroup parameter to the metric group name.
- MetricTypeName: Also set the MetricType parameter to the metric type name.
- MetricTypes: Also set the MetricTypes parameter to the list of metric types.
Example:
```
All
```
MetricType(required): string
The metric type to include. Only used if MetricSource is set to MetricTypeName.
Example:
```
Latency
```
MetricTypes(required): array[object]
The list of metric types to include. Only used if MetricSource is set to MetricTypes.
Example:
```
Latency
```
ShowMetricGroup(required): boolean

Whether the entire metric group should be included (1) or not (0). Only used if MetricSource is set to MetricTypeName or MetricTypes.
TimeRange(required): string
A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for Start and StopTime.
Example:
```
now-24h..now
```

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

id(required): string
A device name or comma-separated list of device names. Only used if the DeviceSource parameter is set to Device or MultipleDevices.
Example:
```
router.example.com
```
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/metricAllMetricsOverviewRead"
                    }
                }
            }
        }
    ]
}

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

Nested Schema : data

Type: array

Show Source

Array of: object metricAllMetricsOverviewRead

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

Nested Schema : metricAllMetricsOverviewRead

Type: object

Show Source

Abbr: string

Metric Abbreviation

Example: s
Availability: number

Availability of the metric for the specified time range.

Example: 80
AverageUtilization: number

The most recent value of the metric for the specified time range

Example: 50
AverageValue: number

Mean value of the metric for the specified time range.

Example: 1000
DeviceID: string

Device ID related to the following data.

Example: 1555
DeviceName: string

Device Name

Example: router.example.com
DeviceZoneID: integer

Device Zone ID.

Example: 9
DeviceZoneName: string

Device Zone Name

Example: Oracle Lab - Network Equipment
Direction: integer

Direction to sort this metric type in relation to TopN. 0 = descending, 1 = ascending.

Example: 0
DNSName: string

DNS Name

Example: router.example.com
Factor: integer

Factor

Example: 1
InstanceName: string

Instance Name

Example: Device
IPAddress: string

IP Address

Example: 100.77.1.223
IPv6Address: string

IPv6 Address

Example: 2001:DB8::1
LastUtilization: number

The last utilization reported for the metric for the specified time range

Example: 60
LastValue: number

The most recent value of the metric for the specified time range

Example: 5.58996200561523E-4
Maximum: integer

Maximum

Example: 0
MaximumUtilization: number

The maximum utilization of the metric for the specified time range

Example: 100
MaximumValue: number

The maximum value of the metric for the specified time range

Example: 5000
MDSID: string

A combination of the MetricID, DeviceID, and ShardID concatenated with an "_" underscore character.

Example: 642677_1555_1
Measurement: string

Measurement

Example: metrictype_Latency
MetricGroupID: integer

The metric group ID the metric belongs to.

Example: 6
MetricID: integer

Metric ID related to the following data.

Example: 642677
MetricTypeName: string

Metric Type Name

Example: Latency
MinimumUtilization: number

The minimum utilization of the metric for the specified time range

Example: 0
MinimumValue: number

The minimum value of the metric for the specified time range

Example: 0
ParentDeviceID: integer

Parent Device ID. It will be 0 if the device is not virtual. It will be another DeviceID if it is a virtual device.

Example: 0
PeakUtilization: number

Peak utilization is the minimum or maximum depending on metric type direction.

Example: 100
PeakValue: number

Peak value is the minimum or maximum depending on metric type direction.

Example: 5000
PollTime: integer

Poll Time

Example: 60
ShardID: integer

Shard ID

Example: 1
SourceInstanceName: string

Source Instance Name

Example: Device
SumValue: number

The sum of all values for the metric for the specified time range

Example: 300000
Trend: integer

Trend

Example: oracle.doceng.json.BetterJsonNull@11893180
UnitDivision: integer

Unit Division

Example: 60

{
    "properties":{
        "MetricID":{
            "description":"Metric ID related to the following data.",
            "type":"integer",
            "example":"642677"
        },
        "DeviceID":{
            "description":"Device ID related to the following data.",
            "type":"string",
            "example":"1555"
        },
        "ParentDeviceID":{
            "description":"Parent Device ID. It will be 0 if the device is not virtual. It will be another DeviceID if it is a virtual device.",
            "type":"integer",
            "example":"0"
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "DNSName":{
            "description":"DNS Name",
            "type":"string",
            "example":"router.example.com"
        },
        "IPAddress":{
            "description":"IP Address",
            "type":"string",
            "example":"100.77.1.223"
        },
        "IPv6Address":{
            "description":"IPv6 Address",
            "type":"string",
            "example":"2001:DB8::1"
        },
        "DeviceZoneID":{
            "description":"Device Zone ID.",
            "type":"integer",
            "example":"9"
        },
        "DeviceZoneName":{
            "description":"Device Zone Name",
            "type":"string",
            "example":"Oracle Lab - Network Equipment"
        },
        "Maximum":{
            "description":"Maximum",
            "type":"integer",
            "example":"0"
        },
        "MetricTypeName":{
            "description":"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":"The metric group ID the metric belongs to.",
            "type":"integer",
            "example":"6"
        },
        "UnitDivision":{
            "description":"Unit Division",
            "type":"integer",
            "example":"60"
        },
        "Direction":{
            "description":"Direction to sort this metric type in relation to TopN. 0 = descending, 1 = ascending.",
            "type":"integer",
            "example":"0"
        },
        "ShardID":{
            "description":"Shard ID",
            "type":"integer",
            "example":"1"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"Device"
        },
        "PollTime":{
            "description":"Poll Time",
            "type":"integer",
            "example":"60"
        },
        "Factor":{
            "description":"Factor",
            "type":"integer",
            "example":"1"
        },
        "SourceInstanceName":{
            "description":"Source Instance Name",
            "type":"string",
            "example":"Device"
        },
        "MDSID":{
            "description":"A combination of the MetricID, DeviceID, and ShardID concatenated with an \"_\" underscore character.",
            "type":"string",
            "example":"642677_1555_1"
        },
        "Availability":{
            "description":"Availability of the metric for the specified time range.",
            "type":"number",
            "example":"80"
        },
        "AverageValue":{
            "description":"Mean value of the metric for the specified time range.",
            "type":"number",
            "example":"1000"
        },
        "MinimumValue":{
            "description":"The minimum value of the metric for the specified time range",
            "type":"number",
            "example":"0"
        },
        "MaximumValue":{
            "description":"The maximum value of the metric for the specified time range",
            "type":"number",
            "example":"5000"
        },
        "LastValue":{
            "description":"The most recent value of the metric for the specified time range",
            "type":"number",
            "example":5.58996200561523E-4
        },
        "AverageUtilization":{
            "description":"The most recent value of the metric for the specified time range",
            "type":"number",
            "example":"50"
        },
        "MinimumUtilization":{
            "description":"The minimum utilization of the metric for the specified time range",
            "type":"number",
            "example":"0"
        },
        "MaximumUtilization":{
            "description":"The maximum utilization of the metric for the specified time range",
            "type":"number",
            "example":"100"
        },
        "LastUtilization":{
            "description":"The last utilization reported for the metric for the specified time range",
            "type":"number",
            "example":"60"
        },
        "SumValue":{
            "description":"The sum of all values for the metric for the specified time range",
            "type":"number",
            "example":"300000"
        },
        "Trend":{
            "description":"Trend",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "PeakValue":{
            "description":"Peak value is the minimum or maximum depending on metric type direction.",
            "type":"number",
            "example":"5000"
        },
        "PeakUtilization":{
            "description":"Peak utilization is the minimum or maximum depending on metric type direction.",
            "type":"number",
            "example":"100"
        }
    },
    "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