1. REST API for Unified Assurance Core
  2. Tasks
  3. Metrics
  4. Metric Thresholds

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
  • 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.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • 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
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The metric thresholds that match the specified query parameters.
Show Source
Nested Schema : metricThresholdsRead
Type: object
Show Source
  • The abnormal profile ID, used by abnormal thresholds only. For all other threshold types, the value of this is 0.
    Example: 0
  • The abnormal profile name, used by abnormal thresholds only. For all other threshold types, the value of this is None.
    Example: None
  • The location of threshold checking, for standard thresholds only. Allowed Values are 1 for the Threshold Engine or 2 for an application.
    Example: 1
  • The name of the check location.
    Example: Threshold Engine
  • The critical threshold comparison operator. Allowed values are:
    • ==
    • !=
    • >
    • >=
    • <
    • <=
    Example: ==
  • The critical severity, used in the warning event. Allowed Values are:
    • 0: Normal
    • 1: Info
    • 2: Unknown
    • 3: Minor
    • 4: Major
    • 5: Critical
    Example: 5
  • The critical value to test for.
    Example: 0
  • Used when Type is set to Trend Prediction. The relative time, starting now, to use when predicting when the metric value will breach the threshold. For example, set it to 6M to notify when the threshold is expected to be breached within six months.
    The format is a combination of a numerical value and one of the following duration values:
    • m: Minutes
    • h: Hours
    • d: Days
    • w: Weeks
    • M: Months
    • Y: Years
    Example: 6M
  • Used when Type is set to Standard and CheckLocation is set to Threshold Engine. How often the threshold is checked. This should not be less than the PollTime for the Standard Thresholding Engine (default is one minute) or the metric the threshold is for (default is five minutes).
    The format is a combination of a numerical value and one of the following duration values:
    • m: Minutes
    • h: Hours
    • d: Days
    • w: Weeks
    • M: Months
    • Y: Years
    Example: 5m
  • The string representing the metric stored in the Metric database.
    Example: metrictype_Latency
  • The message for the threshold event. Usually appears in an event's Summary field in the event list.
    Example: Performance threshold violation: Device Down
  • The data type that the threshold checks. Allowed values are:
    • availability
    • utilization
    • value
    Example: availability
  • The metric type name.
    Example: Latency
  • Used when Type is set to Standard and CheckLocation is set to Threshold Engine. The offset to apply to the time range. For example, set to 5m to go back five minutes when checking the threshold to ensure most recent poll data is considered. Set to 0m for no offset.
    The format is a combination of a numerical value and one of the following duration values:
    • m: Minutes
    • h: Hours
    • d: Days
    • w: Weeks
    • M: Months
    • Y: Years
    Example: 0m
  • The metric threshold status. Either Disabled or Enabled.
    Example: Enabled
  • The metric threshold status icon. For example, a green orb for enabled status.
    Example: OrbGreen.png
  • The metric threshold status ID. Either 0 (disabled) or 1 (enabled).
    Example: 1
  • The threshold function ID.
    Example: 1
  • The threshold function name. Allowed values are:
    • 95th Percentile: Use when you do not want to count infrequently-occurring high outliers and odd values, when most data points will be under a certain value.
    • Count: Use to ensure there is no missing data, when you expect data points frequently. For example, if you expected a data point every minute, checking a TimeRange of X minutes every Y minutes shows if data is missing after the last Y minutes.
    • Maximum: Use to ensure all data is below a certain value.
    • Mean: Use to consider the average of the values.
    • Minimum: Use to ensure the data never falls below a certain value.
    • Standard Deviation: Use when the variation of data points should be below a certain value.
    Example: Mean
  • The threshold ID.
    Example: 1
  • The threshold name.
    Example: Device Down
  • The ID of the threshold type. Allowed values are:
    • 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 - Advanced
    Example: 1
  • The threshold type name
    Example: Standard
  • Unless Type is set to Abnormal, the period of time in which data points are retrieved and evaluated.
    This must be a combination of a numerical value and one of the following duration values:
    • m: Minutes
    • h: Hours
    • d: Days
    • w: Weeks
    • M: Months
    • Y: Years
    Example: 15m
  • The warning threshold comparison operator. Allowed values are:
    • ==
    • !=
    • >
    • >=
    • <
    • <=
    Example: !=
  • The warning severity, used in the warning event. Allowed Values are:
    • 0: Normal
    • 1: Info
    • 2: Unknown
    • 3: Minor
    • 4: Major
    • 5: Critical
    Example: 3
  • The warning value to test for.
    Example: 0

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top