REST API for Unified Assurance Core

Get Performance Data Details for a Grid Display

get

/api/metric/PerformanceData/readDetails

Gets performance data details for a grid display. You can specify either of the following combinations:

MetricID, DeviceID, and ZoneID
DeviceName, DeviceZoneName, MetricType, and Instance

If you specify both, the names take precedence.

Request

Query Parameters

Delimiter: string

The single character used to separate names in string values of the DeviceName, Instance, MetricType, and DeviceZoneName parameters.

DeviceID(required):

Match All

string

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

Example: 40

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

DeviceName(required):

Match All

string

Device Name (or multiple, comma-separated Device Names)

Example: router.example.com

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

DeviceZoneID(required): integer
The ID of the device zone to get performance data for.
Example:
```
1
```
DeviceZoneName(required): string
The name of the device zone to get performance data for.
Example:
```
Default First Zone
```

Instance(required):

Match All

string

Metric Instance Name (or multiple, comma-separated Metric Instance Names)

Example: Device

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

MetricID(required):

Match All

string

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

Example: 154

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

MetricType(required):

Match All

string

Metric Type Name (or multiple, comma-separated Metric Type Names)

Example: Latency

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

ShowMetricGroup(required):

Match All

boolean

Show all Metrics in Metric Type Group based on single MetricID

Example: 1

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

TimeRange(required):
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/schemas/metricPerformanceData/properties/TimeRange"
        }
    ]
}
```
limit: integer(int32)
The number of records to limit results by.
Example:
```
100
```
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":{
                    "description":"The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string \"Value_\" concatenated with the metric ID.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricPerformanceDataReadDetails"
                    }
                },
                "metaData":{
                    "description":"A description of the data.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "GraphTitle":{
                                "description":"The title for the display.",
                                "type":"string"
                            },
                            "root":{
                                "description":"The name of the root data element.",
                                "type":"string"
                            },
                            "columns":{
                                "description":"A description of the columns the data should be displayed in.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "dataIndex":{
                                            "description":"The data index containing the data for this column.",
                                            "type":"string"
                                        },
                                        "minWidth":{
                                            "description":"The minimum width for the column in pixels.",
                                            "type":"integer"
                                        },
                                        "test":{
                                            "description":"The title for the column.",
                                            "type":"string"
                                        },
                                        "width":{
                                            "description":"The column width in pixels.",
                                            "type":"integer"
                                        },
                                        "flex":{
                                            "description":"The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.",
                                            "type":"integer"
                                        }
                                    }
                                }
                            },
                            "fields":{
                                "description":"The data index to link data to the columns.",
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    ]
}

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

The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string "Value_" concatenated with the metric ID.
metaData: array metaData

A description of the 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":{
            "description":"The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string \"Value_\" concatenated with the metric ID.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricPerformanceDataReadDetails"
            }
        },
        "metaData":{
            "description":"A description of the data.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "GraphTitle":{
                        "description":"The title for the display.",
                        "type":"string"
                    },
                    "root":{
                        "description":"The name of the root data element.",
                        "type":"string"
                    },
                    "columns":{
                        "description":"A description of the columns the data should be displayed in.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "dataIndex":{
                                    "description":"The data index containing the data for this column.",
                                    "type":"string"
                                },
                                "minWidth":{
                                    "description":"The minimum width for the column in pixels.",
                                    "type":"integer"
                                },
                                "test":{
                                    "description":"The title for the column.",
                                    "type":"string"
                                },
                                "width":{
                                    "description":"The column width in pixels.",
                                    "type":"integer"
                                },
                                "flex":{
                                    "description":"The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.",
                                    "type":"integer"
                                }
                            }
                        }
                    },
                    "fields":{
                        "description":"The data index to link data to the columns.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: array

The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string "Value_" concatenated with the metric ID.

Show Source

Array of: object metricPerformanceDataReadDetails

{
    "description":"The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string \"Value_\" concatenated with the metric ID.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricPerformanceDataReadDetails"
    }
}

Nested Schema : metaData

Type: array

A description of the data.

Show Source

Array of: object items

{
    "description":"A description of the data.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "GraphTitle":{
                "description":"The title for the display.",
                "type":"string"
            },
            "root":{
                "description":"The name of the root data element.",
                "type":"string"
            },
            "columns":{
                "description":"A description of the columns the data should be displayed in.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "dataIndex":{
                            "description":"The data index containing the data for this column.",
                            "type":"string"
                        },
                        "minWidth":{
                            "description":"The minimum width for the column in pixels.",
                            "type":"integer"
                        },
                        "test":{
                            "description":"The title for the column.",
                            "type":"string"
                        },
                        "width":{
                            "description":"The column width in pixels.",
                            "type":"integer"
                        },
                        "flex":{
                            "description":"The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.",
                            "type":"integer"
                        }
                    }
                }
            },
            "fields":{
                "description":"The data index to link data to the columns.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : metricPerformanceDataReadDetails

Type: object

Show Source

EpochTime: integer

Epoch Time

Example: 1.6963248E12
Time: string

Date and time formatted for human readability

Example: 2023-10-03 04:20:00
Value_157: integer

Value of the metric type. Here 157 is metric type ID

Example: 5.08975982666016E-4
Value_158: integer

Value of the metric type. Here 158 is metric type ID

Example: 0
Value_159: integer

Value of the metric type. Here 159 is metric type ID

Example: 5.60310151841905E-4

{
    "properties":{
        "Time":{
            "description":"Date and time formatted for human readability",
            "type":"string",
            "example":"2023-10-03 04:20:00"
        },
        "EpochTime":{
            "description":"Epoch Time",
            "type":"integer",
            "example":1.6963248E12
        },
        "Value_157":{
            "description":"Value of the metric type. Here 157 is metric type ID",
            "type":"integer",
            "example":5.08975982666016E-4
        },
        "Value_158":{
            "description":"Value of the metric type. Here 158 is metric type ID",
            "type":"integer",
            "example":0
        },
        "Value_159":{
            "description":"Value of the metric type. Here 159 is metric type ID",
            "type":"integer",
            "example":5.60310151841905E-4
        }
    },
    "type":"object"
}

Nested Schema : items

Type: object

Show Source

columns: array columns

A description of the columns the data should be displayed in.
fields: array fields

The data index to link data to the columns.
GraphTitle: string

The title for the display.
root: string

The name of the root data element.

{
    "type":"object",
    "properties":{
        "GraphTitle":{
            "description":"The title for the display.",
            "type":"string"
        },
        "root":{
            "description":"The name of the root data element.",
            "type":"string"
        },
        "columns":{
            "description":"A description of the columns the data should be displayed in.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dataIndex":{
                        "description":"The data index containing the data for this column.",
                        "type":"string"
                    },
                    "minWidth":{
                        "description":"The minimum width for the column in pixels.",
                        "type":"integer"
                    },
                    "test":{
                        "description":"The title for the column.",
                        "type":"string"
                    },
                    "width":{
                        "description":"The column width in pixels.",
                        "type":"integer"
                    },
                    "flex":{
                        "description":"The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.",
                        "type":"integer"
                    }
                }
            }
        },
        "fields":{
            "description":"The data index to link data to the columns.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : columns

Type: array

A description of the columns the data should be displayed in.

Show Source

Array of: object items

{
    "description":"A description of the columns the data should be displayed in.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dataIndex":{
                "description":"The data index containing the data for this column.",
                "type":"string"
            },
            "minWidth":{
                "description":"The minimum width for the column in pixels.",
                "type":"integer"
            },
            "test":{
                "description":"The title for the column.",
                "type":"string"
            },
            "width":{
                "description":"The column width in pixels.",
                "type":"integer"
            },
            "flex":{
                "description":"The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : fields

Type: array

The data index to link data to the columns.

Show Source

Array of: string

{
    "description":"The data index to link data to the columns.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

dataIndex: string

The data index containing the data for this column.
flex: integer

The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.
minWidth: integer

The minimum width for the column in pixels.
test: string

The title for the column.
width: integer

The column width in pixels.

{
    "type":"object",
    "properties":{
        "dataIndex":{
            "description":"The data index containing the data for this column.",
            "type":"string"
        },
        "minWidth":{
            "description":"The minimum width for the column in pixels.",
            "type":"integer"
        },
        "test":{
            "description":"The title for the column.",
            "type":"string"
        },
        "width":{
            "description":"The column width in pixels.",
            "type":"integer"
        },
        "flex":{
            "description":"The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.",
            "type":"integer"
        }
    }
}

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