deviationDefinition

Extends:	reportDefinition
Namespace:	(default namespace)
XML Schema:	api.xsd

Deviation definition contains properties that describe deviation report.

JSON Example

 {
  "properties":["TraffIn"],
  "aggValue":8,
  "stdDevMultiple":2.1,
  "thresholdValue":10.5,
  "hasRawData":false,
  "hasTable":false,
  "definitionId":0,
  "name":null,
  "reportType":"Deviation",
  "objectType":"Interfaces",
  "group":null,
  "subGroup":null,
  "query":null,
  "filter":null,
  "objectKeys":[
   {"keyPairs":[
    {"name":"Node",
    "value":"192.168.243.0/24:BgpPsn"
    },
    {"name":"Name",
    "value":"xe-0/1/0"
    }
   ]}
  ],
  "timeRangeUnits":"year",
  "timeRangeValue":"3",
  "timeFrom":null,
  "timeTo":null,
  "hasCumulativeSum":false,
  "aggregateAfterGroupBy":false,
  "cumulativeGroupBy":null
 }

JSON

property	type	description
properties	array of properties (string)	High frequency property. Examples: Traffic Out, Traffic In, Util In, Util Out, Packets In, Packets Out, Error Packets In, Dropped Packets Out etc
aggValue	aggValue (int)	Aggregation value indicates how many data points as the aggregate interval
stdDevMultiple	stdDevMultiple (double)	Standard deviation multiple which controls the range of the lower / upper band. Default is 2 which means deviation from 2 standard deviation
thresholdValue	thresholdValue (double)	Threshold value. Default is 0 which means ignore the deviation data points if the differences of the current value and the last value is less than the threshold value, precondition is the current value should be larger than the upper band or smaller than the lower band