Get Access Point Statistics

To retrieve the access point statistics:
  1. Log in to the REST API server using administrator credentials. You must also forward the session ID variable with each API call.
  2. Use the GET method to access the /ap_stats endpoint and fetch the access point statistics.

    Sample Request

    curl -X GET --cookie auth_token=$cookie http://134.141.242.93/nsight-ui/api/v1/ap_stats
    Click to expand in new window

    Query String Parameters

    Parameter Required/Optional Description Data Type
    count Optional The latest number of entries to be returned in the response. If you omit this parameter, all access point entries are returned. Integer

    Sample Response (200 OK)

    {    
    "count": 2,    
    "data": [        
    {            
      "ap":[                
      {                    
        "apid": "00236822A4D8",                    
        "cc_24": 0,                    
        "cc_5": 0,                    
        "cctotal": 0,                    
        "ch_util_24": 0,                    
        "ch_util_5": 0,                    
        "noise_24": 0,                    
        "noise_5": 0,                    
        "q_24": 0,                    
        "q_5": 0,                    
        "ri":
          [                       
            null,                       
            null                   
            ],                    
      "rssi_24": 0,                    
      "rssi_5": 0,                    
      "rssi_ri_24": 0,                    
      "rssi_ri_5": 0,                    
      "rtry_24": 0,                    
      "rtry_5": 0,                    
      "rtry_ri_24": 0,                    
      "rtry_ri_5": 0,                    
      "rx_24": 0,                    
      "rx_5": 0,                    
      "rxbps_24": 0,                    
      "rxbps_5": 0,                    
      "rxd_24": 0,                    
      "rxd_5": 0,                    
      "rxd_ri_24": 0,                    
      "rxd_ri_5": 0,
      "rxtotal": 0,                    
      "snr_24": 0,                    
      "snr_5": 0,                    
      "snr_ri_24": 0,                    
      "snr_ri_5": 0,                    
      "t_24": 0,                    
      "t_5": 0,                    
      "tx_24": 0,                    
      "tx_5": 0,                    
      "txbps_24": 0,                    
      "txbps_5": 0,                    
      "txd_24": 0,                    
      "txd_5": 0,                    
      "txd_ri_24": 0,                    
      "txd_ri_5": 0,                    
      "txtotal": 0,                    
      "usagetotal": 0,                    
      "wired": [                       
        {                           
            "ifname": "up1",                           
            "rx": 0,                           
            "totrx": 0,                           
            "tottx": 0,                           
            "tx": 0                       
         },                       
         {                           
            "ifname": "ge5",                           
            "rx": 0,                           
            "totrx": 0,                           
            "tottx": 0,                           
            "tx": 0                       
         },                        
         {                           
            "ifname": "ge4",                           
            "rx": 0,                           
            "totrx": 116233337,                           
            "tottx": 287063276,                           
            "tx": 0                       
          },                       
          {                           
            "ifname": "ge3",                           
            "rx": 219614,                           
            "totrx": 1137602159,                           
            "tottx": 520035714,                            
            "tx": 1197285                       
          },                       
          {                           
            "ifname": "ge2",                           
            "rx":
            1714209,                           
            "totrx": 599461146,                           
            "tottx": 1485347811,
            "tx": 50294                       
           },                       
           {                           
            "ifname": "ge1",                           
            "rx": 9711,                           
            "totrx": 310967043,                           
            "tottx": 522568719,                           
            "tx": 17386                       
           }                   
          ]                
        }            
       ],            
      "cc_24": 0,            
      "cc_5": 0,            
      "cctotal": 0,            
      "ch_util_24": 0,            
      "ch_util_5": 0,            
      "i": 60,            
      "noise_24": 0,            
      "noise_5": 0,            
      "q_24": 0,            
      "q_5": 0,            
      "rfd": "rfs",            
      "rssi_24": 0,            
      "rssi_5": 0,            
      "rssi_ri_24": 0,            
      "rssi_ri_5": 0,            
      "rtry_24": 0,            
      "rtry_5": 0,            
      "rtry_ri_24": 0,            
      "rtry_ri_5": 0,            
      "rx_24": 0,            
      "rx_5": 0,            
      "rxbps_24": 0,            
      "rxbps_5": 0,            
      "rxd_24": 0,            
      "rxd_5": 0,            
      "rxd_ri_24": 0,            
      "rxd_ri_5": 0,            
      "rxtotal": 0,            
      "snr_24": 0,            
      "snr_5": 0,            
      "snr_ri_24": 0,            
      "snr_ri_5": 0,            
      "t_24": 0,            
      "t_5": 0,            
      "tx_24": 0,            
      "tx_5": 0,            
      "txbps_24": 0,            
      "txbps_5": 0,            
      "txd_24": 0,
      "txd_5": 0,            
      "txd_ri_24": 0,            
      "txd_ri_5": 0,            
      "txtotal": 0,            
      "usagetotal": 0        
      },        
      {            
      "ap":[                
      {                    
        "apid": "7467F75C21F1",                    
        "cc_24": 0,                    
        "cc_5": 0,                    
        "cctotal": 0,                    
        "ch_util_24": 84,                    
        "ch_util_5": 21,                    
        "noise_24": -87,                    
        "noise_5": -92,                    
        "q_24": 0,                    
        "q_5": 0,                    
        "ri":
          [                       
            {                           
            "cc":0,                           
            "ch_util": 84,                           
            "noise": -87,                           
            "q":0,                           
            "rf-mode": 0,                           
            "riid": 1,                           
            "rssi": 0,                           
            "rtry": 0,                           
            "rx":0,                           
            "rxbps": 0,                           
            "rxd":0,                           
            "snr":0,                           
            "t":0,                           
            "tx":0,                           
            "txbps": 1,                           
            "txd":0,                           
            "wl":
            [                               
              {                                   
                "cc":0,                                   
                "rx":0,                                   
                "tx":0,                                   
                "wlid": "3DFB0202"                               
            },                              
              {                                   
                "cc":0,                                   
                "rx":0,                                   
                "tx":0,                                   
                "wlid": "4A74BD85"                               
              }                           
             ]
          },                       
            {                           
              "cc":0,                           
              "ch_util": 21,                           
              "noise": -92,                           
              "q": 0,                           
              "rf-mode": 1,                           
              "riid": 2,                           
              "rssi": 0,                           
              "rtry": 0,                           
              "rx": 0,                           
              "rxbps": 0,                           
              "rxd": 0,                           
              "snr": 0,                           
              "t": 0,                           
              "tx": 0,                           
              "txbps": 1,                           
              "txd": 0,                           
              "wl":[                        
              {                                   
                "cc":0,                                   
                "rx":0,                                   
                "tx":0,                                   
                "wlid": "3DFB0202"                               
              },                               
              {                                   
                "cc":0,                                   
                "rx":0,                                   
                "tx":0,                                   
                "wlid": "4A74BD85"                               
              }]                       
              }                   
              ],                    
            "rssi_24": 0,                    
            "rssi_5": 0,                    
            "rssi_ri_24": 0,                    
            "rssi_ri_5": 0,                    
            "rtry_24": 0,                    
            "rtry_5": 0,                    
            "rtry_ri_24": 0,                    
            "rtry_ri_5": 0,                    
            "rx_24": 0,                    
            "rx_5": 0,                    
            "rxbps_24": 0,                    
            "rxbps_5": 0,                    
            "rxd_24": 0,                    
            "rxd_5": 0,                    
            "rxd_ri_24": 0,                    
            "rxd_ri_5": 0,                    
            "rxtotal": 0,
            "snr_24": 0,                    
            "snr_5": 0,                    
            "snr_ri_24": 0,                    
            "snr_ri_5": 0,                    
            "t_24": 0,                    
            "t_5": 0,                    
            "tx_24": 0,                    
            "tx_5": 0,                    
            "txbps_24": 1,                    
            "txbps_5": 1,                    
            "txd_24": 0,                    
            "txd_5": 0,                    
            "txd_ri_24": 0,                    
            "txd_ri_5": 0,                    
            "txtotal": 0,                    
            "usagetotal": 0,                    
            "wired": [                       
            {                           
              "ifname": "ge2",                           
              "rx": 0,                           
              "totrx": 22230,                           
              "tottx": 25504,                           
              "tx": 0                       
            },                       
            {                           
              "ifname": "ge1",                           
              "rx":18396,                           
              "totrx": 533339920,                           
              "tottx": 316811241,                           
              "tx": 11162                       
            }]                
          },                
          {                    
            "apid": "B4C7996C87DB",                    
            "wired": [                       
            {                           
              "ifname": "xge4",                           
              "rx":0,                           
              "totrx": 0,                           
              "tottx": 0,                           
              "tx":0                       
            },                       
            {                           
              "ifname": "xge3",                           
              "rx": 0,                           
              "totrx": 0,                           
              "tottx": 0,                           
              "tx": 0                       
            },                       
            {                           
              "ifname": "xge2",                           
              "rx": 0,                           
              "totrx": 0,                           
              "tottx": 0,                           
              "tx": 0                       
            },                       
            {                           
              "ifname": "xge1",                           
              "rx": 0,                           
              "totrx": 0,                           
              "tottx": 0,                           
              "tx": 0                       
            },                       
            {                           
              "ifname": "ge2",                           
              "rx": 32423,                           
              "totrx": 8094700,                           
              "tottx": 23170262,                           
              "tx": 23894                       
            },                       
            {                            
              "ifname": "ge1",                           
              "rx": 0,                           
              "totrx": 0,                           
              "tottx": 0,                           
              "tx": 0                       
            }                   
          ]                
        }],            
      "cc_24": 0,            
      "cc_5": 0,            
      "cctotal": 0,            
      "ch_util_24": 84,            
      "ch_util_5": 21,            
      "i": 60,            
      "noise_24": -87,            
      "noise_5": -92,            
      "q_24": 0,            
      "q_5": 0,            
      "rfd": "test",            
      "rssi_24": 0,            
      "rssi_5": 0,            
      "rssi_ri_24": 0,            
      "rssi_ri_5": 0,            
      "rtry_24": 0,            
      "rtry_5": 0,            
      "rtry_ri_24": 0,            
      "rtry_ri_5": 0,            
      "rx_24": 0,            
      "rx_5": 0,            
      "rxbps_24": 0,            
      "rxbps_5": 0,            
      "rxd_24": 0,            
      "rxd_5": 0,            
      "rxd_ri_24": 0,            
      "rxd_ri_5": 0,            
      "rxtotal": 0,            
      "snr_24": 0,            
      "snr_5": 0,            
      "snr_ri_24": 0,            
      "snr_ri_5": 0,            
      "t_24": 0,            
      "t_5": 0,            
      "tx_24": 0,            
      "tx_5": 0,            
      "txbps_24": 1,            
      "txbps_5": 1,            
      "txd_24": 0,            
      "txd_5": 0,            
      "txd_ri_24": 0,            
      "txd_ri_5": 0,            
      "txtotal": 0,            
      "usagetotal": 0        
      }],    
    "success": true
    }
    Click to expand in new window

    Response Parameters

    Parameter Description Data Type
    apid Access point MAC address String
    cc_24 Client count on 2.4 GHz band Integer
    cc_5 Client count on 5 GHz band Integer
    cctotal CPU process utilization Integer
    ch_util_24 Channel utilization on 2.4GHz band Integer
    ch_util_5 Channel utilization on 5 GHz band Integer
    noise_24 Noise floor on 2.4 GHz band in dB Integer
    noise_5 Noise floor on 5 GHz band in dB Integer
    q_24 Quality index on 2.4 GHz band Integer
    q_5 Quality index on 5 GHz band Integer
    rssi_24 RSSI in 2.4 GHz band in dB Integer
    rssi_5 RSSI in 5 GHz band in dB Integer
    rssi_ri_24 RSSI reference index in 2.4 GHz band in range 1-5 Integer
    rssi_ri_5 RSSI reference index in 5 GHz band in range 1-5 Integer
    retry_24 Retry count on 2.4 GHz band Integer
    retry_5 Retry count on 5 GHz band Integer
    retry_ri_24 Retries reference index in 2.4 GHz band in range 1-5 Integer
    retry_ri_5 Retries reference index in 5 GHz band in range 1-5 Integer
    rx_24 Receive octets on 2.4 GHz band Integer
    rx_5 Receive octets on 5 GHz band Integer
    rxbps_24 Receive rate on 2.4 GHz band in bps Integer
    rxbps_5 Receive rate on 5 GHz band in bps Integer
    rxd_24 Receive data rate on 2.4 GHz band in bps Integer
    rxd_5 Receive data rate on 5 GHz band in bps Integer
    rxd_ri_24 RX data rate reference index in 2.4 GHz band in range 1-5 Integer
    rxd_ri_5 RX data rate reference index in 5 GHz band in range 1-5 Integer
    rxtotal Total receive octets  
    snr_24 SNR on 2.4 GHz band in dB Integer
    snr_5 SNR on 5 GHz band in dB Integer
    snr_ri_24 SNR reference index in 2.4 GHz in range 1-5 Integer
    snr_ri_5 SNR reference index in 5 GHz in range 1-5 Integer
    t_24 Theoretical max speed reference index in 2.4 GHz in range 1-5 Integer
    t_5 Theoretical max speed reference index in 5 GHz in range 1-5 Integer
    tx_24 Transmit octets on 2.4 GHz band Integer
    tx_5 Transmit octets on 5 GHz band Integer
    txbps_24 Transmit rate on 2.4 GHz band in bps Integer
    txbps_5 Transmit rate on 5 GHz band in bps Integer
    txd_24 Transmit data rate on 2.4 GHz band in bps Integer
    txd_5 Transmit data rate on 5 GHz band in bps Integer
    txd_ri_24 Transmit data rate reference index in 2.4 GHz band in range 1-5 Integer
    txd_ri_5 Transmit data rate reference index in 5 GHz band in range 1-5 Integer
    txtotal Total tranmsit octets Integer
    usagetotal Total usage octets Integer
    ri Radio index (0 based) Array
    cc Overall client count Integer
    ch_util Overall channel utilization Integer
    noise Overall noise floor in dB Integer
    q Overall quality index Integer
    rf_mode Radio band in GHz Integer
    riid Radio index Integer
    rssi Overall RSSI in dB Integer
    rtry Overall retry count Integer
    rx Overall receive octets Integer
    rxbps Overall receive rate in bps Integer
    rxd Overall receive data rate in bps Integer
    snr Overall SNR in dB Integer
    t Overall theoretical max speed reference index in range 1-5 Integer
    tx Overall transmit octets Integer
    txbps Overall transmit rate in bps Integer
    txd Overall transmit data rate in bps Integer
    wl WLAN info Array
    cc Client count Integer
    rx Receive octets Integer
    tx Transmit octets Integer
    wlid WLAN index String
    wired Wired Info Array
    ifname Ethernet port name String
    rx Receive octets Integer
    tx Transmit octets Integer
    totrx Total receive octets Integer
    totx Total transmit octets Integer
    i Entry index Integer