getSiteRunningSpectrumAnalysis
Get the running 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
uuidResponse Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/analyze_spectrum"{ "band": "5", "channels": [ 36, 40, 44, 48 ], "device_id": "00000000-0000-0000-1000-5c5b35bd76bb", "duration": 600, "format": "stream", "started_time": 1435080709, "width": 20}listSiteSlesMetrics GET
List the metrics for the given scope
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 }, ... ] } } ```