Get Metric Thresholds
get
/api/metric/Thresholds
Gets the metric thresholds that match the specified query parameters. If no parameters are specified, all metric thresholds are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
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 metric thresholds that match the specified query parameters.
-
total: integer
The total number of results regardless of pagingExample:
1
Nested Schema : data
Type:
array
The metric thresholds that match the specified query parameters.
Show Source
Nested Schema : metricThresholdsRead
Type:
Show Source
object
-
AbnormalProfileID: integer
Abnormal Profile ID used by Abnormal Thresholds only Allowed Values: - 0 => NoneExample:
0
-
AbnormalProfileName: string
Abnormal Profile NameExample:
None
-
CheckLocation: integer
Location of threshold checking (Standard only) Allowed Values: - 1 => Threshold Engine - 2 => ApplicationExample:
1
-
CheckLocationName: string
Check Location NameExample:
Threshold Engine
-
CriticalOperator: string
Operator Allowed Values: - == - != - < - > - <= ->==>Example:
==
-
CriticalSeverity: integer
Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = CriticalExample:
5
-
CriticalValue: number
Value to test forExample:
0
-
ForecastTimeRange: string
(Trend Prediction Only) Relative time from now in a friendly text formatExample:
-
Frequency: string
If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", how often the threshold is being checked. This should not be less than the PollTime. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for daysExample:
5m
-
Measurement: string
String representing a metric stored in influxExample:
metrictype_Latency
-
Message: string
Threshold MessageExample:
Performance threshold violation: Device Down
-
MetricField: string
String of metric being collectedExample:
availability
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
Offset: string
If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", what offset to apply to the time range, e.g "Go back 5 minutes when checking the threshold to ensure most recent poll data is considered". 0 minutes means no offset. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for daysExample:
0m
-
Status: string
StatusExample:
Enabled
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: boolean
Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
ThresholdFunctionID: integer
Threshold Function IDExample:
1
-
ThresholdFunctionName: string
Threshold Function NameExample:
Mean
-
ThresholdID: integer
Threshold IDExample:
1
-
ThresholdName: string
Threshold NameExample:
Device Down
-
ThresholdTypeID: integer
Allowed Values: - 1 => Availability - Standard - 2 => Performance Utilization - Standard - 3 => Performance Value - Standard - 10 => Trend % Daily - Advanced - 14 => Abnormal Daily - Advanced - 16 => Missing Data - Advanced - 20 => Trend Prediction Availability - Advanced - 21 => Trend Prediction Performance Utilization - Advanced - 22 => Trend Prediction Performance Value - AdvancedExample:
1
-
ThresholdTypeName: string
Threshold Type NameExample:
Standard
-
TimeRange: string
Unless Type is set to "Abnormal", the period of time where data points will be retrieved and evaluated. This must be a combination of a numerical value and a duration, which must be set to one of the following:- - s for seconds - m for minutes - h for hours - d for daysExample:
15m
-
WarningOperator: string
Warning OperatorExample:
-
WarningSeverity: integer
Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = CriticalExample:
3
-
WarningValue: number
Value to test forExample:
0
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