Qodex.ai

Total Clients Count

GET {{base_url}}/monitoring/v1/clients/count?group=<string>&swarm_id=<string>&label=<string>&network=<string>&cluster_id=<string>&stack_id=<string>&device_type=<string>&serial=<string>&band=<string>&radio_number=<integer>&from_timestamp=<integer>&to_timestamp=<integer>

Get the total clients connected Possible error_codes for the error responses are 1. 0001 - General Error. 2. 0002 - Validation Error. Out of Range value for a query parameter. 3. 0003 - Validation Error. Unsupported query combination 4. 0004 - Validation Error. Invalid value for a query parameter 5. 0005 - Validation Error. Missing required query parameter

Request Params

KeyDatatypeRequiredDescription
groupstringFilter by group name
swarm_idstringFilter by Swarm ID. Field supported for AP clients only
labelstringFilter by Label name
networkstringFilter by network name. Field supported for wireless clients only
cluster_idstringFilter by Mobility Controller serial number
stack_idstringFilter by Switch stack_id
device_typestringFilter by device type. Value can be either "AP" or "Switch"
serialstringFilter by Ap or serial
bandstringFilter by band. Value can be either "2.4", "5" or "6". Valid only when serial parameter is specified.
radio_numberstringFilter by radio_number (0, 1 or 2). Valid only when serial parameter is specified. If band is provided and radio_number is not provided then radio_number is defaulted to 0, 1 and 2 for band 5, 2.4 and 6 respectively.
from_timestampstringNeed information from this timestamp. Timestamp is epoch in seconds. Default is current timestamp minus 3 hours
to_timestampstringNeed information to this timestamp. Timestamp is epoch in seconds. Default is current timestamp

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;interval&quot;:&quot;\u003cstring\u003e&quot;,&quot;samples&quot;:[{&quot;client_count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;client_count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cnumber\u003e&quot;}]}