REST API for Unified Assurance Core

Get Metrics

get

/api/metric/Metrics

Gets the metrics that match the specified query parameters. If no parameters are specified, all metrics are returned. Oracle recommends using filtering and pagination parameters to limit the results.

Request

Query Parameters

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

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

Nested Schema : data

Type: array

Show Source

Array of: object metricMetricsRead

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

Nested Schema : metricMetricsRead

Type: object

Show Source

Abbr: string

Metric Abbreviation

Example: %
CustomMaximum: number

Metric Custom Maximum to override auto maximum
DeviceHost: string

Device Host. The host is DNSName, IPv6Address, or IPAddress.

Example: 191.1.1.44
DeviceID: integer

ID of Device from Assure1.Devices

Example: 1599
DeviceName: string

Device Name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used.

Example: 460056A
DeviceShardID: integer

Device Shard ID

Example: 1
DeviceZoneID: integer

Device Zone ID

Example: 1
DeviceZoneName: string

Device Zone Name

Example: Default First Zone
DisplayInstanceName: string

Display Instance Name

Example: 1 Minute Average
Factor: integer

Factor

Example: 1
InstanceID: integer

ID of Instance from Assure1.metricInstances

Example: 0
InstanceName: string

Instance Name

Example: Device
Maximum: integer

Maximum

Example: 100
Measurement: string

The influxDB measurement name.

Example: metrictype_Ping_Jitter_Utilization
MethodID: integer

ID from Assure1.MetricMethods

Example: 0
MethodName: string

Method Name

Example: NA
MetricID: integer

Metric ID

Example: 587889
MetricName: string

Metric Name

Example: Device
MetricTypeID: integer

ID of Metric Type from Assure1.MetricTypes

Example: 63
MetricTypeName: string

Metric Type Name

Example: Ping Jitter Utilization
PollTime: integer

Metric collection interval (used for display only)

Example: 300
ShardID: integer

ID of the shard the metric resides on

Example: 1
StateIcon: string

Flag to indicate if the metric has data. Allowed values:- "OrbGreen.png" or "OrbYellow.png"

Example: OrbYellow.png
StateName: string

Flag to indicate if the metric has data. Allowed values:- "Data Exists" or "No Data"

Example: No Data
StatusIcon: string

Status Icon

Example: OrbGreen.png
StatusID: integer

The metric status ID. Either 0 (disabled) or 1 (enabled).

Example: 1
StatusName: string

Status Name

Example: Enabled
Thresholds: array Thresholds

collection of assigned thresholds
Unit: string

Unit of the metric type, i.e. Seconds, Errors, Bits per Second, etc.

Example: Percent
UnitDivision: integer

Unit division Allowed Values: - 0 => None - 60 => Time - 1000 => SI (1000) - 1024 => Binary/IEC (1024)

Example: 0

{
    "properties":{
        "MetricID":{
            "description":"Metric ID",
            "type":"integer",
            "example":"587889"
        },
        "DeviceID":{
            "description":"ID of Device from Assure1.Devices",
            "type":"integer",
            "example":"1599"
        },
        "DeviceName":{
            "description":"Device Name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used.",
            "type":"string",
            "example":"460056A"
        },
        "DeviceHost":{
            "description":"Device Host. The host is DNSName, IPv6Address, or IPAddress.",
            "type":"string",
            "example":"191.1.1.44"
        },
        "MetricTypeID":{
            "description":"ID of Metric Type from Assure1.MetricTypes",
            "type":"integer",
            "example":"63"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Ping Jitter Utilization"
        },
        "InstanceID":{
            "description":"ID of Instance from Assure1.metricInstances",
            "type":"integer",
            "example":"0"
        },
        "MetricName":{
            "description":"Metric Name",
            "type":"string",
            "example":"Device"
        },
        "DisplayInstanceName":{
            "description":"Display Instance Name",
            "type":"string",
            "example":"1 Minute Average"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"Device"
        },
        "StatusID":{
            "description":"The metric status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "StatusName":{
            "description":"Status Name",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "Maximum":{
            "description":"Maximum",
            "type":"integer",
            "example":"100"
        },
        "DeviceZoneID":{
            "description":"Device Zone ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"Device Zone Name",
            "type":"string",
            "example":"Default First Zone"
        },
        "Measurement":{
            "description":"The influxDB measurement name.",
            "type":"string",
            "example":"metrictype_Ping_Jitter_Utilization"
        },
        "DeviceShardID":{
            "description":"Device Shard ID",
            "type":"integer",
            "example":"1"
        },
        "CustomMaximum":{
            "description":"Metric Custom Maximum to override auto maximum",
            "type":"number"
        },
        "Factor":{
            "description":"Factor",
            "type":"integer",
            "example":"1"
        },
        "UnitDivision":{
            "description":"Unit division\n\nAllowed Values:\n- 0 => None\n- 60 => Time\n- 1000 => SI (1000)\n- 1024 => Binary/IEC (1024)",
            "type":"integer",
            "example":"0"
        },
        "Unit":{
            "description":"Unit of the metric type, i.e. Seconds, Errors, Bits per Second, etc.",
            "type":"string",
            "example":"Percent"
        },
        "Abbr":{
            "description":"Metric Abbreviation",
            "type":"string",
            "example":"%"
        },
        "MethodID":{
            "description":"ID from Assure1.MetricMethods",
            "type":"integer",
            "example":"0"
        },
        "MethodName":{
            "description":"Method Name",
            "type":"string",
            "example":"NA"
        },
        "PollTime":{
            "description":"Metric collection interval (used for display only)",
            "type":"integer",
            "example":"300"
        },
        "ShardID":{
            "description":"ID of the shard the metric resides on",
            "type":"integer",
            "example":"1"
        },
        "Thresholds":{
            "description":"collection of assigned thresholds",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Measurement":{
                        "description":"Measurement",
                        "type":"string",
                        "example":"metrictype_Ping_Jitter_Utilization"
                    },
                    "ThresholdID":{
                        "description":"Threshold ID",
                        "type":"integer",
                        "example":19
                    },
                    "ThresholdName":{
                        "description":"Threshold Name",
                        "type":"string",
                        "example":"Ping Jitter Utilization High"
                    },
                    "MetricTypeName":{
                        "description":"Metric Type Name",
                        "type":"string",
                        "example":"Ping Jitter Utilization"
                    }
                }
            }
        },
        "StateName":{
            "description":"Flag to indicate if the metric has data. Allowed values:- \"Data Exists\" or \"No Data\"",
            "type":"string",
            "example":"No Data"
        },
        "StateIcon":{
            "description":"Flag to indicate if the metric has data. Allowed values:- \"OrbGreen.png\" or \"OrbYellow.png\"",
            "type":"string",
            "example":"OrbYellow.png"
        }
    },
    "type":"object"
}

Nested Schema : Thresholds

Type: array

collection of assigned thresholds

Show Source

Array of: object items

{
    "description":"collection of assigned thresholds",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Measurement":{
                "description":"Measurement",
                "type":"string",
                "example":"metrictype_Ping_Jitter_Utilization"
            },
            "ThresholdID":{
                "description":"Threshold ID",
                "type":"integer",
                "example":19
            },
            "ThresholdName":{
                "description":"Threshold Name",
                "type":"string",
                "example":"Ping Jitter Utilization High"
            },
            "MetricTypeName":{
                "description":"Metric Type Name",
                "type":"string",
                "example":"Ping Jitter Utilization"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

Measurement: string

Measurement

Example: metrictype_Ping_Jitter_Utilization
MetricTypeName: string

Metric Type Name

Example: Ping Jitter Utilization
ThresholdID: integer

Threshold ID

Example: 19
ThresholdName: string

Threshold Name

Example: Ping Jitter Utilization High

{
    "type":"object",
    "properties":{
        "Measurement":{
            "description":"Measurement",
            "type":"string",
            "example":"metrictype_Ping_Jitter_Utilization"
        },
        "ThresholdID":{
            "description":"Threshold ID",
            "type":"integer",
            "example":19
        },
        "ThresholdName":{
            "description":"Threshold Name",
            "type":"string",
            "example":"Ping Jitter Utilization High"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Ping Jitter Utilization"
        }
    }
}

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.