Prime 3.7 API: Getting total connected clients on a SSID and VLAN

[ritwikpandav]

We have a setup where a SSID "Test" has two VLANs configured on it:

VLAN ID: 1701 and VLAN Name: pax

VLAN ID:1702 and VLAN Name: crew

We are attempting to extract the total number of devices connected to the SSID "Test" on VLAN 1701.

We have tried the following APIs, but they seem to giving inaccurate (overestimated) information:

1. /webacs/api/v4/data/Clients?ssid=eq("Test")&vlanId=1701

The "@count" value in the response is 7812

2. /webacs/api/v4/data/ClientDetails?ssid=eq("Test")&vlan=eq("1701")

The "@count" value in the response is 7812

If we use the /webacs/api/v4/op/statisticsService/clients/distributions/countBySsid API, the count value received in the response for the "XValue": "Test" is 2362 - which is accurate. 

Any idea why are the GET Client Summary and GET Client Details returning values more than the total clients present on the SSID? Is it an issue with the filters? Is there a better way of extracting the information we need? 

[ritwikpandav · Accepted solution]

Realized that the overestimated information was because both APIs return connected clients with different status values. The information that ensures the same count requires another filter status = ASSOCIATED be added to the APIs. 

1. /webacs/api/v4/data/Clients?ssid=eq("Test")&vlanId=1701&status=eq(ASSOCIATED)

2. /webacs/api/v4/data/ClientDetails?ssid=eq("Test")&vlan=eq("1701")&status=eq(ASSOCIATED)

the status field (clientStatusEnum) has the following possible values:

• IDLE
• AUTHPENDING
• AUTHENTICATED
• ASSOCIATED
• POWERSAVE
• DISASSOCIATED
• TOBEDELETED
• PROBING
• BLACKLISTED
• NOTCONFIGURED
• UNAUTHENTICATED