v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Switch

Get Top-N Switch interface trends

Get top N Switches interface trends, rx bytes, tx bytes over a given time period

get/network-monitoring/v1/switches/topn-interface-trends

Query parameters

site-idstring const

Example:123682

ID of the site for which location analytics trends is requested.

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). By default, aggregation is performed for three hours after the specified timestamp when only the gt operator is used, or up to the specified timestamp when only the lt operator is used. Supported fields, operators and value format are in the below given table.

Field	Operators	Format
timestamp	gt and lt	Date-time (RFC 3339 timestamp in UTC+0) string

The operators are implemented as follows:

gt: Used to indicate the start of the timestamp range.
lt: Used to indicate the end of the timestamp range.

Response

Object containing interface trends related to the switches.

countinteger required

Total number of switches.

Example response

{
  "items": [
    {
      "id": "720f147c3de211ef99bca6b05da42930",
      "type": "network-monitoring/switch-monitoring",
      "serial": "CN95367H9C",
      "siteId": "22966851366752256",
      "name": "HP2530-24G-PoEP Switch",
      "rxBytes": 788724,
      "txBytes": 758346
    }
  ],
  "count": 2
}