v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Site Health

List of sites with client health

This API returns a list of sites with the number of poor, fair and good health clients, categorized as wired and wireless for each site.

get/network-monitoring/v1/sites-client-health

Query parameters

limitinteger

Specifies the number of sites to be returned per request. Maximum limit per request is 1000.

Example:10

Specifies the number of sites to be returned per request. Maximum limit per request is 1000.

offsetinteger

Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.

filterstring const

Example:siteName in ('site1', 'site2')

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
siteId	eq and in
siteName	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring const

Example:wirelessClientHealth ASC

Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are siteName, clientHealth, wirelessClientHealth, wiredClientHealth

Response

Success

countinteger required

Number of items in the response.

totalinteger required

Specifies the total number of sites available for a given customer.

offsetinteger required

Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.

Example response

{
  "items": [
    {
      "id": "00001",
      "type": "network-monitoring/sites-client-health",
      "siteName": "12345678",
      "clientTypes": [
        {
          "name": "Wireless",
          "health": {
            "groups": [
              {
                "name": "Fair",
                "value": 4
              }
            ]
          }
        }
      ]
    }
  ],
  "count": 1,
  "total": 10,
  "response": {
    "status": "SUCCESS",
    "code": "SITE-HEALTH-SUCCESS-001",
    "message": "Sites details fetched successfully"
  }
}