trendingDefinition
| Extends: | reportDefinition |
| Namespace: | (default namespace) |
| XML Schema: | api.xsd |
Trending definition contains properties that describe trending report.
JSON Example
{
"properties":[
"TraffOut",
"TraffIn"
],
"aggregationModes"["P95"],
"aggPeriodUnits":"week",
"aggPeriodValue":"1",
"hasRawData":false,
"hasTable":false,
"graphPeriodUnits":"week",
"graphPeriodValue":"1",
"graphThresholdUnits":"percent",
"graphThresholdValue":"80",
"definitionId":0,
"name":null,
"reportType":"Trending",
"objectType":"Interfaces",
"group":"Capacity",
"subGroup":"1000",
"query":null,
"filter":null,
"objectKeys":null,
"timeRangeUnits":"month",
"timeRangeValue":"1",
"timeFrom":null,
"timeTo":null,
"hasCumulativeSum":false,
"cumulativeGroupBy":null,
"trendingAlgoTypes":"Linear",
"projectionDate":null
}
JSON
| property | type | description |
|---|---|---|
| properties | array of properties (string) | Property list includes Traffic In or/and Traffic Out |
| aggregationModes | array of aggregationModes (string) |
Aggregation modes. Examples: P95, Maximum, Minimum, or Average |
| aggPeriodUnits | aggPeriodUnits (string) |
Aggregation period units. Examples: hour, day, week, month or year |
| aggPeriodValue | aggPeriodValue (int) | Aggregation period value |
| graphPeriodUnits | graphPeriodUnits (string) |
Graph period units. Examples: week, month or year |
| graphPeriodValue | graphPeriodValue (int) | Graph period value |
| graphThresholdUnits | graphThresholdUnits (string) |
Graph threshold units. Examples: percent or mbps |
| graphThresholdValue | graphThresholdValue (double) | Graph threshold value |
| trendingAlgoTypes | trendingAlgoTypes (string) |
Comma-delimited list of trending growth algorithm types. Examples: Exponential, Linear, Logarithmic or Power |
| projectionDate | projectionDate (string) | Projection date |
| projPeriodUnits | projPeriodUnits (string) |
Projected period units. Examples: week, month or year |
| projPeriodValue | projPeriodValue (int) | Projected period value |