listSiteSpectrumAnalysis
List the past spectrum analysis for a site
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidQuery Parameters
Maximum number of results to return per page
0 <= value100Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/stats/analyze_spectrum"{ "end": 1694708579, "limit": 10, "results": [ { "band": "5", "channel_usage": [ { "channel": 36, "noise": -78, "non_wifi": 0.08, "wifi": 0.13 } ], "fft_samples": [ { "frequency": 2437, "rssi": -92, "signal7": -93 } ], "mac": "5c5b35bd76bb", "org_id": "f2695c32-0e83-4936-b1b2-96fc88051213", "timestamp": 1694098696 } ], "start": 1694622179, "total": 4}initiateSiteAnalyzeSpectrum POST
Initiate a spectrum analysis for a site The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/sites/{site_id}/analyze_spectrum" } ``` #### Example output from ws stream ```json { "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/analyze_spectrum", "data": { "session": "session_id", "fft_samples": [ { "frequency": 2437.0, "rssi / signal ?": -93 }, ... ], "channel_usage": [ { "channel": 36, "noise": -78, "wifi": 0.13, "non_wifi": 0.08 }, ... ] } } ```
getSiteStats GET
Get Sites Stats