Since Product Version: 3.1
Resource URL
/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
metric required |
path |
The metric name for which the data need to be fetched. |
String |
device required |
query |
The IP address of the device to which the interface belongs. |
String |
ifName required |
query |
Name of the interface for which the metric data need to be fetched. |
Integer |
timeInterval optional |
query |
Specifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided. |
Long |
startTime optional |
query |
Specifies the start time in seconds. The timeInterval parameter overrides this parameter. |
Long |
endTime optional |
query |
Specifies the end time in seconds. The timeInterval parameter overrides this parameter. |
Boolean |
isFullHierarchy optional |
query |
Specifies full or short class hierarchy which is needed. Used in QOS Class Map and QOS Class Map Top Trend metrics. Default is false. |
Integer |
direction optional |
query |
Direction (1 - input, 2 - output). Used in QOS Class Map Top Trend metric. Default is 2. |
String |
qosRateField optional |
query |
One of dropPolicyToggle, prePolicyToggle, postPolicyToggle. Used in QOS Class Map Top Trend metric. Default is dropPolicyToggle. |
String |
trafficDirection optional |
query |
One of ALL, IN, OUT. Used in Top N Application and Top Application Traffic Overtime metrics. Default is ALL. |
String |
sortOrder optional |
query |
One of DESC, ASC. Used in Top N Application and Top Application Traffic Overtime metrics. Default is DESC. |
String |
networkAwareType optional |
query |
Network aware. Wireless: 1, Wired: 2, All: -1. Used in Top N Application and Top Application Traffic Overtime metrics. Default is -1. |
String |
appId optional |
query |
Comma separated application IDs. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all applications). |
String |
siteId optional |
query |
Site ID. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all sites). |
String |
dataType optional |
query |
One of rate, volume. Used in Top N Application and Top Application Traffic Overtime metrics. Default is rate. |
String |
dscp optional |
query |
DSCP. Used in Top N Application metric. |
String |
metricDataType optional |
query |
One of TOP_N, TIME_SERIES. Current metric's default data type is used if this parameter is not set. |
Integer |
firstResult optional |
header |
Defines the offset from the first result you want to fetch. Default is 0. |
Integer |
maxResults optional |
header |
Defines maximum amount of hits to be returned. Default is 20. |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
currentDateTime |
Current timestamp |
String |
description |
Metric description |
String |
metricName |
Metric name |
metricRows |
Metric data list |
|
String |
resourceName |
Resource name |
xValueProperty |
Properties of X values |
|
yValueProperty |
Properties of Y values |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}?device="192.168.0.1"&ifName="eth0"&timeInterval=1
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}?device=&quot;192.168.0.1&quot;&amp;ifName=&quot;eth0&quot;&amp;timeInterval=1 " rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <metricData> <currentDateTime>String value</currentDateTime> <description>String value</description> <metricName>String value</metricName> <metricRows> <metricRows> <issue>String value</issue> <XValue>String value</XValue> <YLabels> <YLabels>String value</YLabels> </YLabels> <YValues> <YValues>15.0</YValues> </YValues> </metricRows> </metricRows> <resourceName>String value</resourceName> <XValueProperty> <label>String value</label> <unit>NUMBER</unit> </XValueProperty> <YValueProperty> <YValueProperty> <label>String value</label> <maxVal>4.0</maxVal> <minVal>4.0</minVal> <unit>NUMBER</unit> </YValueProperty> </YValueProperty> </metricData> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}.json?device="192.168.0.1"&ifName="eth0"&timeInterval=1
{ "mgmtResponse" : { "@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}?device="192.168.0.1"&ifName="eth0"&timeInterval=1\n\t\t\t\t\t", "@responseType" : "operation", "@rootUrl" : "https://172.25.123.114/webacs/api/v1/op/", "metricData" : [ { "currentDateTime" : "String value", "description" : "String value", "metricName" : "String value", "metricRows" : { "metricRows" : [ { "issue" : "String value", "xvalue" : "String value", "ylabels" : { "ylabels" : [ "String value" ] }, "yvalues" : { "yvalues" : [ 15.0 ] } } ] }, "resourceName" : "String value", "xvalueProperty" : { "label" : "String value", "unit" : "NUMBER" }, "yvalueProperty" : { "yvalueProperty" : [ { "label" : "String value", "maxVal" : 4.0, "minVal" : 4.0, "unit" : "NUMBER" } ] } } ] } }