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
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
-
string
-
DeviceName(required):
Match All
-
string
Device Name (or multiple, comma-separated Device Names)Example:
router.example.com
-
string
-
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
-
string
-
MetricID(required):
Match All
-
string
Metric ID (or multiple, comma-separated Metric IDs)Example:
154
-
string
-
MetricType(required):
Match All
-
string
Metric Type Name (or multiple, comma-separated Metric Type Names)Example:
Latency
-
string
-
ShowMetricGroup(required):
Match All
-
boolean
Show all Metrics in Metric Type Group based on single MetricIDExample:
1
-
boolean
-
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
-
string
-
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.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
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
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
Nested Schema : metricPerformanceDataReadDetails
Type:
Show Source
object
-
EpochTime: integer
Epoch TimeExample:
1.6963248E12
-
Time: string
Date and time formatted for human readabilityExample:
2023-10-03 04:20:00
-
Value_157: integer
Value of the metric type. Here 157 is metric type IDExample:
5.08975982666016E-4
-
Value_158: integer
Value of the metric type. Here 158 is metric type IDExample:
0
-
Value_159: integer
Value of the metric type. Here 159 is metric type IDExample:
5.60310151841905E-4
Nested Schema : items
Type:
Show Source
object
-
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.
Nested Schema : columns
Type:
array
A description of the columns the data should be displayed in.
Show Source
Nested Schema : items
Type:
Show Source
object
-
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.
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object