Get Performance Data
get
/api/metric/PerformanceData
Gets the performance data that matches the specified query parameters. If no parameters are specified, all performance data are returned.
Identify the series you want performance data for by specifying DeviceName, either Measurement or MetricType, and Instance. For example, use the following in your request:
DeviceName=router.example.com&Measurement=metrictype_Latency&Instance=Device
Identify the time ranges you want performance data for by specifying TimeRange, with start and end separated by ... Use the following letters to indicate units of time: d for m for minute, h for hour, d for day, w for week, M for month, and y for year. Use now to get dates relative to the current day. You can also enter an absolute time in YYYY-MM-DD HH-MM-SS format.
For example:
The level of aggregation for values is determined by the time range and will automatically pick the best database retention policy.
Identify the series you want performance data for by specifying DeviceName, either Measurement or MetricType, and Instance. For example, use the following in your request:
DeviceName=router.example.com&Measurement=metrictype_Latency&Instance=Device
Identify the time ranges you want performance data for by specifying TimeRange, with start and end separated by ... Use the following letters to indicate units of time: d for m for minute, h for hour, d for day, w for week, M for month, and y for year. Use now to get dates relative to the current day. You can also enter an absolute time in YYYY-MM-DD HH-MM-SS format.
For example:
- The last two days: now-2d..now
- The last 6 months: now-6M..now
- The last 5 years: now-5y..now
- Yesterday: now-1d/d..now-1d/d
- Today: now/d..now/d
- This week so far: now/w..now
- This month: now/M..now/M
- The last 5 minutes: now-5m..now
- The Last 24 hours: now-24h..now
- Absolute time range: 2020-01-01 00:00:00..2020-01-01 12:00:00
The level of aggregation for values is determined by the time range and will automatically pick the best database retention policy.
Request
Query Parameters
-
DeviceID:
Match All
-
string
Device ID (or multiple, comma-separated Device IDs)Example:
40
-
string
-
DeviceName:
Match All
-
string
Device Name (or multiple, comma-separated Device Names)Example:
router.example.com
-
string
-
DeviceZoneName: string
Device zone name.
-
GraphTitle:
Match All
-
string
Custom title to be used on the graph
-
string
-
Instance:
Match All
-
string
Metric Instance Name (or multiple, comma-separated Metric Instance Names)Example:
Device
-
string
-
MetricID:
Match All
-
string
Metric ID (or multiple, comma-separated Metric IDs)Example:
154
-
string
-
MetricType:
Match All
-
string
Metric Type Name (or multiple, comma-separated Metric Type Names)Example:
Latency
-
string
-
Navigator: boolean
Whether to include the NavigatorPoints navigation series (1) or not (0).
-
ShowMetricGroup:
Match All
-
boolean
Show all Metrics in Metric Type Group based on single MetricIDExample:
1
-
boolean
-
StartTime:
Deprecated way of specifying start time. Use the TimeRange parameter instead.Match All
-
integer
StartTime in epoch time secondsExample:
now
-
integer
-
StopTime:
Deprecated way of specifying stop time. Use the TimeRange parameter instead.Match All
-
integer
StopTime in epoch time secondsExample:
now
-
integer
-
TimeRange:
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
Root Schema : schema
Type:
Show Source
object
-
data: array
data
The performance data.
-
message: string
The text of the response message.Example:
Loaded 1 entries
-
success: boolean
Success or failure responseExample:
true
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricPerformanceDataRead
Type:
Show Source
object
-
Abbr: string
Unit abbreviationExample:
b
-
AbnormalConfidence: array
AbnormalConfidence
Abnormal confidence band points with each point containing the epoch time in milliseconds, lower value as float, and upper value as float (e.g. `[1234567890000, 0.0, 2000.00]`)
-
AbnormalPoints: array
AbnormalPoints
Abnormal data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
-
AverageUtilization: number
Average (mean) utilizationExample:
50
-
AverageValue: number
Average (mean) valueExample:
1000
-
DeviceName: string
Device Name Defined in order or precedence from: `CustomName > DNSName > SysName > IPv6Address > IPAddress`Example:
router.example.com
-
DeviceZoneID: integer
Device zone ID.
-
DeviceZoneName: string
Device zone name
-
Factor: integer
Factor to change units into rawExample:
8
-
GraphTitle: string
Graph title to display based on type of dataExample:
Graph Title
-
InstanceName: string
Metric Instance NameExample:
Device
-
LastUtilization: number
Last utilization reportedExample:
60
-
LastValue: number
Last value reportedExample:
1500
-
Maximum: integer
Metric Maximum (0 for no max)Example:
0
-
MaximumUtilization: number
Maximum utilizationExample:
100
-
MaximumValue: number
Maximum valueExample:
5000
-
MetricGroupName: string
Metric Group Name for displaying metrics togetherExample:
Network Traffic
-
MetricID: integer
Metric IDExample:
1
-
MetricInstanceName: string
Metric Display (custom) Instance NameExample:
Device
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
MinimumUtilization: number
Minimum utilizationExample:
0
-
MinimumValue: number
Minimum valueExample:
0
- navigationRetention: string
- NavigatorParams: object NavigatorParams
- NavigatorPoints: array NavigatorPoints
-
ParentDeviceName: string
Parent Device Name (if virtual)Example:
parent.example.com
-
PeakUtilization: number
Peak utilization is the minimum or maximum depending on metric type direction.Example:
100
-
PeakValue: number
Peak value is the minimum or maximum depending on metric type direction.Example:
5000
-
Points: array
Points
Data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
-
PollTime: integer
Poll TimeExample:
300
-
retention: string
Retention period the data was pulled from.
-
Stacked: integer
Stacking of metrics enabledExample:
0
-
StartTime: integer
Starting epochtime in secondsExample:
1234567890
-
StopTime: integer
Stoping epochtime in secondsExample:
1234567890
-
SumValue: number
Sum of values over the time range. Not valid for all metrics.Example:
300000
-
Threshold: array
Threshold
Array of threshold definitions
-
TrendPoints: array
TrendPoints
Trend data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
-
TrendSlope: number
Slope of points over time rangeExample:
0.1
-
Unit: string
Value unitExample:
bits
-
UnitDivision: integer
Unit division factorExample:
1024
Nested Schema : AbnormalConfidence
Type:
array
Abnormal confidence band points with each point containing the epoch time in milliseconds, lower value as float, and upper value as float
(e.g. `[1234567890000, 0.0, 2000.00]`)
Show Source
Nested Schema : AbnormalPoints
Type:
array
Abnormal data points with each point containing the epoch time in milliseconds and value as float
(e.g. `[1234567890000, 1000.00]`)
Show Source
Nested Schema : Points
Type:
array
Data points with each point containing the epoch time in milliseconds and value as float
(e.g. `[1234567890000, 1000.00]`)
Show Source
Nested Schema : TrendPoints
Type:
array
Trend data points with each point containing the epoch time in milliseconds and value as float
(e.g. `[1234567890000, 1000.00]`)
Show Source
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
Show Source
object
-
CriticalOperator: string
Operator used for the critical state. Allowed values:- "==", "!=", ">=", "<=", ">", "<"< div> "<>=",>
-
CriticalSeverity: integer
Critical Severity. Allowed values:- 0=Normal, 1=Unknown, 2=Info, 3=Minor, 4=Major, 5=Critical
-
CriticalValue: number
Critical value
-
MetricField: string
Type of metric value used by the threshold. Allowed values:- "value", "utilization"
-
ThresholdName: string
Threshold name
-
ThresholdType: string
Threshold type name
-
ThresholdTypeID: integer
Threshold ID
-
WarningOperator: string
Operator used for the warning state. Allowed values:- "==", "!=", ">=", "<=", ">", "<"< div> "<>=",>
-
WarningSeverity: integer
Warning Severity. Allowed values:- 0=Normal, 1=Unknown, 2=Info, 3=Minor, 4=Major, 5=Critical
-
WarningValue: number
Warning value
Nested Schema : items
Type:
object
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