Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/statisticsService/ptp/metrics/{metric}
Request Parameters
metric
String
|
path
|
Required
The metric name for which the data need to be fetched.
|
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
|
endTime
Long
|
query
|
Optional
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
Optional
Determines the query type to retirieve the KPI. Valid values are TOP_N or TIME_SERIES
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yLabels
String[]
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
|
|
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://10.64.88.203/webacs/api/v1/op/statisticsService/ptp/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v1/op/statisticsService/ptp/metrics/{metric}" rootUrl="https://10.64.88.203/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>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v1/op/statisticsService/ptp/metrics/{metric}.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/statisticsService/ptp/metrics/{
metric
}",
"@rootUrl" : "https : //10.64.88.203/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",
"Another string value"]
},
"YValues" : {
"YValues" : [15,
25]
}
},
{
"issue" : "Another string value",
"XValue" : "Another string value",
"YLabels" : {
"YLabels" : ["String value",
"Another string value"]
},
"YValues" : {
"YValues" : [15,
25]
}
}]
},
"resourceName" : "String value",
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"YValueProperty" : [{
"label" : "String value",
"maxVal" : 4,
"minVal" : 4,
"unit" : "NUMBER"
},
{
"label" : "Another string value",
"maxVal" : 14,
"minVal" : 14,
"unit" : "STRING"
}]
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/ptp/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
Required
The metric name for which the data need to be fetched.
|
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
|
endTime
Long
|
query
|
Optional
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
Optional
Determines the query type to retirieve the KPI. Valid values are TOP_N or TIME_SERIES
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yLabels
String[]
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
|
|
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://10.64.88.203/webacs/api/v2/op/statisticsService/ptp/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v2/op/statisticsService/ptp/metrics/{metric}" rootUrl="https://10.64.88.203/webacs/api/v2/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>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v2/op/statisticsService/ptp/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.88.203/webacs/api/v2/op/statisticsService/ptp/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/ptp/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
Required
The metric name for which the data need to be fetched.
|
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
|
endTime
Long
|
query
|
Optional
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
Optional
Determines the query type to retirieve the KPI. Valid values are TOP_N or TIME_SERIES
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yLabels
String[]
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
|
|
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://10.64.88.203/webacs/api/v3/op/statisticsService/ptp/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v3/op/statisticsService/ptp/metrics/{metric}" rootUrl="https://10.64.88.203/webacs/api/v3/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>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v3/op/statisticsService/ptp/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.88.203/webacs/api/v3/op/statisticsService/ptp/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/ptp/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
Required
The metric name for which the data need to be fetched.
|
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
|
endTime
Long
|
query
|
Optional
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
Optional
Determines the query type to retirieve the KPI. Valid values are TOP_N or TIME_SERIES
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yLabels
String[]
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
|
|
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://10.64.88.203/webacs/api/v4/op/statisticsService/ptp/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v4/op/statisticsService/ptp/metrics/{metric}" rootUrl="https://10.64.88.203/webacs/api/v4/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>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v4/op/statisticsService/ptp/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.88.203/webacs/api/v4/op/statisticsService/ptp/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}