Get Summary Performance Information
get
/api/metric/PerformanceData/readSummary
Gets summary, or legend, performance information. You can specify either of the following combinations:
- MetricID and DeviceID
- DeviceName, DeviceZoneName, MetricType, and InstanceName
Request
Query Parameters
-
DeviceID:
Device ID (or multiple, comma-separated Device IDs)Match All
-
string
Device ID (or multiple, comma-separated Device IDs)Example:
40
-
string
-
DeviceName: string
The name of the device to get performance information for.
-
DeviceZoneName: string
The name of the device zone to get performance information for.
-
InstanceName: string
The name of the metric instance to get performance information for.
-
MetricID:
Metric ID (or multiple, comma-separated Metric IDs)Match All
-
string
Metric ID (or multiple, comma-separated Metric IDs)Example:
154
-
string
-
MetricType: string
The name of the metric type to get performance information for.
- StartTime:
- StopTime:
-
TimeRange:
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.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
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 performance data summary that matches the query parameters.
Nested Schema : data
Type:
array
The performance data summary that matches the query parameters.
Show Source
Nested Schema : metricPerformanceDataReadSummary
Type:
Show Source
object
-
Abbr: string
Unit abbreviationExample:
b
-
AverageAvailability: number
Average AvailabilityExample:
1
-
AverageUtilization: number
Average (mean) utilizationExample:
50
-
AverageValue: number
Average (mean) valueExample:
1000
-
Factor: integer
Factor to change units into rawExample:
8
-
InstanceName: string
Metric Instance NameExample:
Device
-
LastAvailability: number
Last AvailabilityExample:
1
-
LastUtilization: number
Last utilization reportedExample:
60
-
LastValue: number
Last value reportedExample:
1500
-
Maximum: integer
Metric Maximum (0 for no max)Example:
0
-
MaximumAvailability: number
Maximum AvailabilityExample:
1
-
MaximumUtilization: number
Maximum utilizationExample:
100
-
MaximumValue: number
Maximum valueExample:
5000
-
Measurement: string
InfluxDB measurement name (or multiple, comma-separated measurements).Example:
metrictype_Latency
-
MetricInstanceName: string
Metric Display (custom) Instance NameExample:
Device
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
MinimumAvailability: number
Minimum AvailabilityExample:
1
-
MinimumUtilization: number
Minimum utilizationExample:
0
-
MinimumValue: number
Minimum valueExample:
0
-
PollTime: integer
Poll TimeExample:
300
-
SumValue: number
Sum of values over the time range. Not valid for all metrics.Example:
300000
-
Unit: string
Value unitExample:
bits
-
UnitDivision: integer
Unit division factorExample:
1024
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