v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Application Visibility

Get top website categories by usage

This API endpoint returns the top N website categories ranked by usage (tx + rx bytes) for the requested scope. The maximum time range is 7 days. If the range between start-at and end-at exceeds 7 days, start-at is automatically adjusted to be 7 days before end-at. This is intentional behavior; no error is returned.

get/network-monitoring/v1/website-categories

Query parameters

start-atstring date-time required

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

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

end-atstring date-time required

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

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

site-idstring const

Example:2778382

Filter by site identifier.

client-idstring const

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

Filter by client MAC address. Forces use of the main data table (not aggregated).

serial-numberstring const

Example:CN12345678

Filter by device serial number. Forces use of the main data table (not aggregated).

limitinteger

Example:20

Maximum number of items to return per page (1–500). Default: 100.

ssidstring const

Example:CorpWiFi

Filter by SSID name.

user-rolestring const

Example:admin

Filter by user role.

offsetinteger

Zero-based index of the first item to return. Default: 0.

topinteger

Example:10

Maximum number of top-ranked website categories to return in total across all pages (1–500). Default: 100.

Response

Successful operation.

countinteger required

Number of category entries returned.

totalinteger required

Total count of items that meet the API request parameters.

offsetinteger required

Example response

{
  "items": [
    {
      "id": "news",
      "type": "network-monitoring/website-category",
      "generation": 1,
      "createdAt": "2024-11-20T14:14:33Z",
      "updatedAt": "2024-11-20T14:14:33Z",
      "displayName": "News",
      "txBytes": 1048576,
      "rxBytes": 5242880
    },
    {
      "id": "social",
      "type": "network-monitoring/website-category",
      "generation": 1,
      "createdAt": "2024-11-20T14:14:33Z",
      "updatedAt": "2024-11-20T14:14:33Z",
      "displayName": "Social Media",
      "txBytes": 524288,
      "rxBytes": 2097152
    }
  ],
  "count": 2,
  "total": 10,
  "offset": 0
}