v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Application Visibility

Get applications accessed in a site

This API endpoint retrieves applications accessed in a site by all clients or by a specific client.

get/network-monitoring/v1/applications

Query parameters

site-idstring const required

Example:2778382

The ID of the site from which applications will be retrieved.

client-idstring const

Example:00:00:00:00:00:00

The client MAC of the source device.

start-atstring date-time required

Example:2024-11-20T14:14:33Z

The start time in RFC 3339 Format (must be within 7 days of end-at).

end-atstring date-time required

Example:2024-11-20T14:14:33Z

The end time in RFC 3339 Format (must be greater than start-at)

limitinteger required

The maximum number of items to return per page.

nextstring

Example:NyBErRdk6czGUyDAX5Cp

Cursor for the next page of results. Use the value returned in the next response field to retrieve the next page. Providing both next and offset in the same request returns 400 Bad Request.

offsetinteger

The offset of the item at which to begin the response. Providing both offset and next in the same request returns 400 Bad Request.

filterstring const

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

Field	Operators	Required	Type	Default Value	Summary
field	eq	No	String	N/A	Format is a string from a specified enum list given below
terms	in	No	String	N/A	Format is a list of strings

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.

List of applicable filters for field and terms

Field	Applicable Terms	Summary
APP_CAT	Refer to list below. Example: ["Antivirus", "Web"]	Returns applications based on application categories
STATE	["allowed", "partial", "blocked"]	Returns applications by assigned permissions
RISK	["Low", "High", "Suspicious", "Moderate", "Trustworthy", "Not Evaluated"]	Returns applications based on risk level
TLS_VERSION	["TLS 1.1", "TLS 1.2"] (examples)	Returns applications by TLS version
APPLICATION_HOST_TYPE	["Hybrid", "Private", "Public"]	Returns applications by host type
COUNTRY	Depends on app server location (use country code, e.g., "IN")	Returns applications by server location
ROLE	Depends on roles assigned to the user	Returns applications by assigned roles

List of application categories available:

Antivirus
Business and Economy
Computer and Internet Info
Computer and Internet Security
Encrypted
Internet Communications
Network Service
Office365 SAAS
Standard
Web

If no filter is passed as the query param, default behavior returns both active and inactive applications.

sortstring const

Example:NAME desc

Sort field followed by direction indicator (asc/desc). Supported fields: NAME, CATEGORY, EXPERIENCE, RISK, USAGE, STATE, LASTUSEDTIME, TLSVERSION, CERTIFICATEEXPIRYDATE, APPLICATIONHOSTTYPE, COUNTRY.

Response

Successful operation.

nextstring required

Specifies the pagination cursor for the next page of resources.

offsetinteger

countinteger required

Number of items in the response.

totalinteger required

Total count of items that meet the API request parameters.

Example response

{
  "items": [
    {
      "type": "/network-monitoring/applications",
      "id": "244",
      "name": "Facebook",
      "categories": [
        "Social Networking",
        "Social Networking Web"
      ],
      "experience": {
        "groups": [
          {
            "count": 0,
            "name": "Poor"
          },
          {
            "count": 0,
            "name": "Fair"
          },
          {
            "count": 4,
            "name": "Good"
          }
        ]
      },
      "risk": "LOW",
      "txBytes": 4615170,
      "rxBytes": 82949479,
      "state": "ALLOWED",
      "lastUsedTime": "1725574810044",
      "tlsVersion": "",
      "certificateExpiryDate": "",
      "applicationHostType": "Public",
      "destLocation": [
        {
          "countryName": "United States"
        }
      ]
    }
  ],
  "count": 1,
  "next": "NyBErRdk6czGUyDAX5Cp",
  "total": 256
}