v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Insights

List source recommendations

Returns AI-powered recommendations for optimizing performance. For site-level granularity site-id and insight-id filter shall be provided and for global recommendations site-id and insight-id filter shall be omitted. At the global level, the API returns global recommendations (across all sites) along with siteId and insightId.

get/network-notifications/v1/insights

Query parameters

site-idstring

Example:6985764272

Site identifier. Omit site-id to retrieve global recommendations across all sites. For site-level recommendations site-id can be obtained from the same API from global recommendations through the field siteId.

insight-idstring

Example:702

Insight identifier. insight-id is used to filter recommendations, it can be obtained from the same API from global-level recommendations through the field 'insightId'.

limitinteger

Example:50

Maximum number of recommendations to return per page.

offsetinteger

Number of recommendations to skip before starting to collect the result set.

sort'ASC' | 'DESC'

Example:ASC

Sort order for recommendations based on implicit field insight-id.

Response

Source recommendations list response.

idstring required

Unique identifier for this API resource.

typestring required

countinteger required

Example response

{
  "id": "network-notifications/v1/insights",
  "type": "collection",
  "items": [
    {
      "timestamp": "1770858000000",
      "tenantId": "c539f92800ea11edbc10aa7fd39913ac",
      "siteId": "6985764272",
      "title": "Access Point Firmware Recommendation",
      "description": "New firmware recommendation available for 3 access point(s) in the site. These upgrades provide new features and bug fixes.",
      "category": "Wireless",
      "insightId": "702",
      "id": "c539f92800ea11edbc10aa7fd39913ac_6985764272_702_8646_4_1770855661607",
      "type": "network-notifications/insight",
      "impactedSites": [
        {
          "siteId": "165678616917",
          "siteName": "Bengaluru (BLR) - Campus"
        }
      ],
      "data": "{\"analyzer_id\":\"c539f92800ea11edbc10aa7fd39913ac_6985764272_702_8646_4_1770855661607\"}"
    }
  ],
  "count": 1
}