REST API for Unified Assurance Core

Get TopN Overview Data

get

/api/metric/TopNData

Gets the TopN overview data for the objects specified in the query parameters.

Request

Query Parameters

DeviceGroup(required): string
The device group to get TopN overview data for.
Example:
```
//Root//Oracle Lab -  test
```
MetricGroupID(required): integer
The ID of the metric group to get TopN overview data for.
Example:
```
0
```
MetricTypeID(required): integer
The ID of the metric type to get TopN overview data for.
Example:
```
0
```
PageSize(required): integer
The number of records to include per page.
Example:
```
10
```

StartTime:

Start Time

Match All

integer

StartTime in epoch time seconds

Example: now

{
    "allOf":[
        {
            "$ref":"#/components/parameters/StartTime"
        }
    ]
}

StopTime:

Stop Time

Match All

integer

StopTime in epoch time seconds

Example: now

{
    "allOf":[
        {
            "$ref":"#/components/parameters/StopTime"
        }
    ]
}

TimeRange:
A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for StartTime and StopTime.

Match All
- string
  
  Shorthand string that encompasses the start and end times in RFC3339 format or relative time literal format. It will take precedence over StartTime if both are passed in.
  
  Example: now-24h..now
```
{
    "allOf":[
        {
            "$ref":"#/components/parameters/TimeRange"
        }
    ]
}
```

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":"Each element is a different data set described by the title.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricTopNDataRead"
                    }
                }
            }
        }
    ]
}

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

Each element is a different data set described by the title.
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":"Each element is a different data set described by the title.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricTopNDataRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Each element is a different data set described by the title.

Show Source

Array of: object metricTopNDataRead

{
    "description":"Each element is a different data set described by the title.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricTopNDataRead"
    }
}

Nested Schema : metricTopNDataRead

Type: object

Show Source

ShardID: integer

Shard ID

Example: 2
StoreData: object StoreData
Title: string

Title

Example: Latency {{{ Average Value }}}

{
    "properties":{
        "Title":{
            "description":"Title",
            "type":"string",
            "example":"Latency {{{ Average Value }}}"
        },
        "ShardID":{
            "description":"Shard ID",
            "type":"integer",
            "example":"2"
        },
        "StoreData":{
            "type":"object",
            "properties":{
                "items":{
                    "description":"Each record is a row of TopN data.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "rank":{
                                "description":"TopN rank",
                                "type":"integer",
                                "example":1
                            },
                            "reportValue":{
                                "description":"Value being scored",
                                "type":"number",
                                "example":0.0019034508784004527
                            },
                            "device":{
                                "description":"Device name",
                                "type":"string",
                                "example":"router.example.com"
                            },
                            "deviceZoneID":{
                                "description":"Device zone ID.",
                                "type":"integer",
                                "example":"9"
                            },
                            "zone":{
                                "description":"Device zone name.",
                                "type":"string",
                                "example":"Oracle Lab - test"
                            },
                            "instance":{
                                "description":"Metric instance name.",
                                "type":"string",
                                "example":"device"
                            },
                            "metrictype":{
                                "description":"Metric type name",
                                "type":"string",
                                "example":"Latency"
                            },
                            "measurement":{
                                "description":"InfluxDB measurement name",
                                "type":"string",
                                "example":"metrictype_Latency"
                            },
                            "abbr":{
                                "description":"Metric unit abbreviation",
                                "type":"string",
                                "example":"s"
                            },
                            "topnScope":{
                                "description":"ID of the TopN scope type: \n\nAllowed Values: 0=Disabled, 1=Utilization, 2=Value, 3=Both",
                                "type":"integer",
                                "example":"3"
                            },
                            "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":"60"
                            }
                        }
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : StoreData

Type: object

Show Source

items: array items

Each record is a row of TopN data.

{
    "type":"object",
    "properties":{
        "items":{
            "description":"Each record is a row of TopN data.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rank":{
                        "description":"TopN rank",
                        "type":"integer",
                        "example":1
                    },
                    "reportValue":{
                        "description":"Value being scored",
                        "type":"number",
                        "example":0.0019034508784004527
                    },
                    "device":{
                        "description":"Device name",
                        "type":"string",
                        "example":"router.example.com"
                    },
                    "deviceZoneID":{
                        "description":"Device zone ID.",
                        "type":"integer",
                        "example":"9"
                    },
                    "zone":{
                        "description":"Device zone name.",
                        "type":"string",
                        "example":"Oracle Lab - test"
                    },
                    "instance":{
                        "description":"Metric instance name.",
                        "type":"string",
                        "example":"device"
                    },
                    "metrictype":{
                        "description":"Metric type name",
                        "type":"string",
                        "example":"Latency"
                    },
                    "measurement":{
                        "description":"InfluxDB measurement name",
                        "type":"string",
                        "example":"metrictype_Latency"
                    },
                    "abbr":{
                        "description":"Metric unit abbreviation",
                        "type":"string",
                        "example":"s"
                    },
                    "topnScope":{
                        "description":"ID of the TopN scope type: \n\nAllowed Values: 0=Disabled, 1=Utilization, 2=Value, 3=Both",
                        "type":"integer",
                        "example":"3"
                    },
                    "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":"60"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Each record is a row of TopN data.

Show Source

Array of: object items

{
    "description":"Each record is a row of TopN data.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rank":{
                "description":"TopN rank",
                "type":"integer",
                "example":1
            },
            "reportValue":{
                "description":"Value being scored",
                "type":"number",
                "example":0.0019034508784004527
            },
            "device":{
                "description":"Device name",
                "type":"string",
                "example":"router.example.com"
            },
            "deviceZoneID":{
                "description":"Device zone ID.",
                "type":"integer",
                "example":"9"
            },
            "zone":{
                "description":"Device zone name.",
                "type":"string",
                "example":"Oracle Lab - test"
            },
            "instance":{
                "description":"Metric instance name.",
                "type":"string",
                "example":"device"
            },
            "metrictype":{
                "description":"Metric type name",
                "type":"string",
                "example":"Latency"
            },
            "measurement":{
                "description":"InfluxDB measurement name",
                "type":"string",
                "example":"metrictype_Latency"
            },
            "abbr":{
                "description":"Metric unit abbreviation",
                "type":"string",
                "example":"s"
            },
            "topnScope":{
                "description":"ID of the TopN scope type: \n\nAllowed Values: 0=Disabled, 1=Utilization, 2=Value, 3=Both",
                "type":"integer",
                "example":"3"
            },
            "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":"60"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

abbr: string

Metric unit abbreviation

Example: s
device: string

Device name

Example: router.example.com
deviceZoneID: integer

Device zone ID.

Example: 9
instance: string

Metric instance name.

Example: device
measurement: string

InfluxDB measurement name

Example: metrictype_Latency
metrictype: string

Metric type name

Example: Latency
rank: integer

TopN rank

Example: 1
reportValue: number

Value being scored

Example: 0.0019034508784004527
topnScope: integer

ID of the TopN scope type: Allowed Values: 0=Disabled, 1=Utilization, 2=Value, 3=Both

Example: 3
unitDivision: integer

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

Example: 60
zone: string

Device zone name.

Example: Oracle Lab - test

{
    "type":"object",
    "properties":{
        "rank":{
            "description":"TopN rank",
            "type":"integer",
            "example":1
        },
        "reportValue":{
            "description":"Value being scored",
            "type":"number",
            "example":0.0019034508784004527
        },
        "device":{
            "description":"Device name",
            "type":"string",
            "example":"router.example.com"
        },
        "deviceZoneID":{
            "description":"Device zone ID.",
            "type":"integer",
            "example":"9"
        },
        "zone":{
            "description":"Device zone name.",
            "type":"string",
            "example":"Oracle Lab - test"
        },
        "instance":{
            "description":"Metric instance name.",
            "type":"string",
            "example":"device"
        },
        "metrictype":{
            "description":"Metric type name",
            "type":"string",
            "example":"Latency"
        },
        "measurement":{
            "description":"InfluxDB measurement name",
            "type":"string",
            "example":"metrictype_Latency"
        },
        "abbr":{
            "description":"Metric unit abbreviation",
            "type":"string",
            "example":"s"
        },
        "topnScope":{
            "description":"ID of the TopN scope type: \n\nAllowed Values: 0=Disabled, 1=Utilization, 2=Value, 3=Both",
            "type":"integer",
            "example":"3"
        },
        "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":"60"
        }
    }
}

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.