Jump to

• Request
• Response

Get Abnormal Profiles

get

/api/metric/AbnormalProfiles

Gets the abnormal profiles that match the specified query parameters. Abnormal profiles are used by abnormal thresholds and the Metric Abnormal Threshold Engine. If no parameters are specified, all abnormal profiles 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

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by. If you do not also set the start parameter, records start at 0.

  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

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object",
      "example":[
          {
              "property":"Name",
              "direction":"ASC"
          },
          {
              "property":"Value",
              "direction":"DESC"
          }
      ]
  }

  Example:

  [
      {
          "property":"Name",
          "direction":"ASC"
      },
      {
          "property":"Value",
          "direction":"DESC"
      }
  ]

• start: integer(int32)
  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

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricAbnormalProfilesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricAbnormalProfilesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricAbnormalProfilesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricAbnormalProfilesRead"
    }
}

Nested Schema : metricAbnormalProfilesRead

Type: object

Show Source

• AbnormalProfileID: integer
  Abnormal Profile ID

  Example: 1
• AbnormalProfileName: string
  Name of abnormal profile

  Example: Default Abnormal Profile
• Alpha: number
  The degree to which the confidence bands smooth a weighted average (more weight being given to recent observations, less to older observations). Values are from >0 to 1. The closer to 1 the Alpha value becomes, the closer the predicted value will be to the weighted average of the last n observations.

  Example: 0.999497
• Beta: number
  The degree to which the smoothing function considers the slope (amount of increase or decrease) of the weighted average of 2 adjacent data points. Values are from >0 to 1. The closer to 1 the Beta value gets, the more the Algorithm will consider the slope of the previous (n-1) data point to the current data point (n) when predicting the next data point (n+1).

  Example: 0.00224
• Delta: number
  Scaling factor, used to influence the width of the confidence bands generated by the Algorithm. Values are between 2 and 3.

  Example: 3
• Epsilon: number
  Epsilon scaling. Values are >0 to 1.

  Example: 0.492391
• FailureThreshold: integer
  Used with Window Length by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered "abnormal" and an event will be generated.

  Example: 3
• Gamma: number
  The degree to which the smoothing function considers seasonal data when forecasting a data point. Values are >0 to 1. The closer to 1 Gamma gets, the more the Algorithm will weight seasonal patterns when forecasting expected values.

  Example: 0.487092
• WindowLength: integer
  Used with Violation Threshold by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered "abnormal" and an event will be generated. Values are between 0 and 28.

  Example: 5

{
    "properties":{
        "AbnormalProfileID":{
            "description":"Abnormal Profile ID",
            "type":"integer",
            "example":"1"
        },
        "AbnormalProfileName":{
            "description":"Name of abnormal profile",
            "type":"string",
            "example":"Default Abnormal Profile"
        },
        "Alpha":{
            "description":"The degree to which the confidence bands smooth a weighted average (more weight being given to recent observations, less to older observations). Values are from >0 to 1. The closer to 1 the Alpha value becomes, the closer the predicted value will be to the weighted average of the last n observations.",
            "type":"number",
            "example":"0.999497"
        },
        "Beta":{
            "description":"The degree to which the smoothing function considers the slope (amount of increase or decrease) of the weighted average of 2 adjacent data points. Values are from >0 to 1. The closer to 1 the Beta value gets, the more the Algorithm will consider the slope of the previous (n-1) data point to the current data point (n) when predicting the next data point (n+1).",
            "type":"number",
            "example":"0.00224"
        },
        "Gamma":{
            "description":"The degree to which the smoothing function considers seasonal data when forecasting a data point. Values are >0 to 1. The closer to 1 Gamma gets, the more the Algorithm will weight seasonal patterns when forecasting expected values.",
            "type":"number",
            "example":"0.487092"
        },
        "Delta":{
            "description":"Scaling factor, used to influence the width of the confidence bands generated by the Algorithm. Values are between 2 and 3.",
            "type":"number",
            "example":"3"
        },
        "Epsilon":{
            "description":"Epsilon scaling. Values are >0 to 1.",
            "type":"number",
            "example":"0.492391"
        },
        "WindowLength":{
            "description":"Used with Violation Threshold by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered \"abnormal\" and an event will be generated. Values are between 0 and 28.",
            "type":"integer",
            "example":"5"
        },
        "FailureThreshold":{
            "description":"Used with Window Length by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered \"abnormal\" and an event will be generated.",
            "type":"integer",
            "example":"3"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top