Fetches the URLs for various metrics of the device.
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 unavailable for this API version
This resource was introduced in API version 2.
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/devices/metrics
Request Parameters
device
String
|
query
|
RequiredThe device IP or name for which the data need to be fetched.
|
timeInterval
Integer
|
query
|
OptionalSpecifies 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
|
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter.
|
Response Parameters
info
String
|
|
metrics
MetricDetailsDTO[]
|
|
description
String
|
|
name
String
|
|
type
MetricTypeEnum
|
|
units
MetricUnitEnum[]
|
Units used in metric
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
url
String
|
|
|
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://localhost/webacs/api/v2/op/statisticsService/devices/metrics?device=172.20.151.111&timeInterval=4
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/statisticsService/devices/metrics?device=172.20.151.111&amp;timeInterval=4" rootUrl="https://localhost/webacs/api/v2/op">
<metricsDTO>
<info>String value</info>
<metrics>
<metrics>
<description>String value</description>
<name>String value</name>
<type>TIME_SERIES</type>
<units>
<units>NUMBER</units>
</units>
<url>String value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/statisticsService/devices/metrics.json?device=172.20.151.111&timeInterval=4
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/devices/metrics?device=172.20.151.111&timeInterval=4",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"metricsDTO" : [ {
"info" : "String value",
"metrics" : {
"metrics" : [ {
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : [ "NUMBER" ]
},
"url" : "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/devices/metrics
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
RequiredThe device IP or name for which the data need to be fetched.
|
timeInterval
Integer
|
query
|
OptionalSpecifies 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
|
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter.
|
Response Parameters
info
String
|
|
metrics
MetricDetailsDTO[]
|
|
description
String
|
|
name
String
|
|
type
MetricTypeEnum
|
|
units
MetricUnitEnum[]
|
Units used in metric
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
url
String
|
|
|
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://localhost/webacs/api/v3/op/statisticsService/devices/metrics?device=172.20.151.111&timeInterval=4
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/statisticsService/devices/metrics?device=172.20.151.111&amp;timeInterval=4" rootUrl="https://localhost/webacs/api/v3/op">
<metricsDTO>
<info>String value</info>
<metrics>
<metrics>
<description>String value</description>
<name>String value</name>
<type>TIME_SERIES</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>String value</url>
</metrics>
<metrics>
<description>Another string value</description>
<name>Another string value</name>
<type>TOP_N</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>Another string value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/statisticsService/devices/metrics.json?device=172.20.151.111&timeInterval=4
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/statisticsService/devices/metrics?device=172.20.151.111&timeInterval=4",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"metricsDTO" : [ {
"info" : "String value",
"metrics" : {
"metrics" : [ {
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "String value"
}, {
"description" : "Another string value",
"name" : "Another string value",
"type" : "TOP_N",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "Another 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/devices/metrics
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
RequiredThe device IP or name for which the data need to be fetched.
|
timeInterval
Integer
|
query
|
OptionalSpecifies 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
|
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter.
|
Response Parameters
info
String
|
|
metrics
MetricDetailsDTO[]
|
|
description
String
|
|
name
String
|
|
type
MetricTypeEnum
|
|
units
MetricUnitEnum[]
|
Units used in metric
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
url
String
|
|
|
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://localhost/webacs/api/v4/op/statisticsService/devices/metrics?device=172.20.151.111&timeInterval=4
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/statisticsService/devices/metrics?device=172.20.151.111&amp;timeInterval=4" rootUrl="https://localhost/webacs/api/v4/op">
<metricsDTO>
<info>String value</info>
<metrics>
<metrics>
<description>String value</description>
<name>String value</name>
<type>TIME_SERIES</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>String value</url>
</metrics>
<metrics>
<description>Another string value</description>
<name>Another string value</name>
<type>TOP_N</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>Another string value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/statisticsService/devices/metrics.json?device=172.20.151.111&timeInterval=4
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/statisticsService/devices/metrics?device=172.20.151.111&timeInterval=4",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"metricsDTO" : [ {
"info" : "String value",
"metrics" : {
"metrics" : [ {
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "String value"
}, {
"description" : "Another string value",
"name" : "Another string value",
"type" : "TOP_N",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "Another string value"
} ]
}
} ]
}
}