getIntfAtAGlanceReportDetails
Provides a consolidated availability and performance monitoring health report data for the given interface.
HTTP Method
GETAPI URL
https://localhost:8060/api/json/v2/device/getIntfAtAGlanceReportDetails?apiKey=***************&InterfaceName=IF-xxx.xxx.xx.4-3820&period=Today
Parameters
| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|
| apiKey | API key to access your OpManager server. | String | - | Yes |
| InterfaceName | Internal name of the interface.
This value can be obtained from the 'interfaceName' field in the listInterfaces API response. | String | - | Yes |
| period | Time period for which the report is to be generated. For 'custom' time period, supply 'startDate' and 'endDate'. | String | Allowed patterns: onehour|twohours|fourhours|sixhours|eighthours|twelvehours|twfourhours|Today|Yesterday|thisweek|lastweek|Last_7_Days|Last_30_Days|Last_60_Days|Last_90_Days|thismonth|Last_Month|Last_3_Months|Last_6_Months|Last_Quarter|This_Quarter|custom.
The default value is 'Today'. | Yes |
| startDate | From Date. This parameter is applicable only if 'custom' time is opted in period param value | String | Allowed values: day/month/year hours:minutes
Example: 13/08/2026 03:00 | No |
| endDate | To Date. This param is applicable only if 'custom' time is opted in period param value | String | Allowed values: day/month/year hours:minutes
Example:13/08/2026 04:00 | No |
Sample Response
HTTP Code: 200
{
"intfDisplayName": "WAN Miniport -IPv6--Npcap Packet Driver -NPCAP--0000-Local Area Connection* 8-Npcap Packet Driver -NPCAP--0000",
"InterfaceCategory": "LAN",
"Details": {
"Parent Name": "opm-core-switch1",
"IfDescr": "WAN Miniport (IPv6)-Npcap Packet Driver (NPCAP)-0000",
"IfAlias": "Local Area Connection* 8-Npcap Packet Driver (NPCAP)-0000",
"IfIndex": "26",
"Receive Bandwidth": "0 bps",
"IfName": "ethernet_8",
"Transmit Bandwidth": "0 bps",
"Circuit ID": "-"
},
"repType": 7,
"graphData": {
"Availability": [
[
"Up",
"90"
],
[
"On Maintenance",
"10"
],
[
"Dependent Unavailable",
"0"
],
[
"On Hold",
"0"
],
[
"Down",
"0"
],
[
"Not Monitored",
"0"
],
[
"Parent Down",
"0"
]
],
"outUtilization": [
{
"seriesname": "outUtilization",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Percentage"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"Discards": [
{
"seriesname": "inDiscards",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Discards/sec"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
},
{
"seriesname": "outDiscards",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Discards/sec"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"outTraffic": [
{
"seriesname": "outTraffic",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"bps"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"Errors": [
{
"seriesname": "inErrors",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Errors/sec"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
},
{
"seriesname": "outErrors",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Errors/sec"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"Unicast": [
{
"seriesname": "broadcast",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"%"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
},
{
"seriesname": "unicast",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"%"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"outBytes": [
{
"seriesname": "outBytes",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
""
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"inTraffic": [
{
"seriesname": "inTraffic",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"bps"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"inBytes": [
{
"seriesname": "inBytes",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Bytes/sec"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"inUtilization": [
{
"seriesname": "inUtilization",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Percentage"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"totalUtilization": [
{
"seriesname": "totalUtilization",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Percentage"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"inFrames": [
{
"seriesname": "inFrames",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Frames/sec"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
],
"outFrames": [
{
"seriesname": "outFrames",
"data": [
[
1785263761113,
0,
"0 "
],
[
1785264361283,
0,
"0 "
],
[
1785264961074,
0,
"0 "
]
],
"xyTitles": [
"Time",
"Frames/sec"
],
"yaxiscolumnorder": [
0
],
"suffix": ""
}
]
}
}
Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute