Field names for API calls

Question

I'm trying to make a api query to /historicalClients/query  (e.g. "https://api.asia.ruckus.cloud/historicalClients/query")

If I omit the fields paramter I just get back an ID for each client. How do I find out what fields are available?

The documentation just has an array of 'string' for the schema.

"fields": [

* "string"

],

I've tried to guess using other values i've seen in other endpoints like /clients

so far I've found id, hostname, ssid. What are the others?

ms264556 · Accepted Answer

The R1 API documentation site is pretty terrible. It's a shame, because the SmartZone API documentation is quite good.

Since you had no answer from a Ruckus person in many days, this may help...

You can sniff the API call by opening your web browser dev tools (F12), navigating to the Network tab, then doing a search on the Clients > Wireless Clients List screen.

You can see that they're looking for eventId [204, 205, 208, 218]. This makes sense: these events are [clientDisconnect, clientInactivityTimeout, clientSessionExpiration, smartRoamDisconnect], which looks like the reasons a client becomes historical.

And they request fields: clientMac, clientIP, userName, hostname, venueId, serialNumber, ssid, disconnectTime, cog, ssid, venueName, apName, evnt_datetime, eventId, networkId.

In addition, I successfully retrieved these fields: rxBytes, txBytes, rxFrames, txFrames.