SitesRRM

getSiteChannelScores

GET
/api/v1/sites/{site_id}/rrm/channel_scores/band/{band}

Get Site Channel Scores

Authorization

Authorization<token>

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

site_id*string
Formatuuid
band*string

802.11 Band

Value in

  • "24"
  • "5"
  • "5-dedicated"
  • "5-selectable"
  • "6"
  • "6-dedicated"
  • "6-selectable"

Query Parameters

ap?string

AP MAC address. When supplied, returns per-AP channel scores instead of site-wide scores.

start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/rrm/channel_scores/band/24"
{  "results": [    {      "channel": 36,      "util_score": 0.009,      "util_score_noise_floor": 0.001,      "util_score_non_wifi": 0.003,      "util_score_other": 0.002,      "util_score_radar": 0,      "util_score_undecodable_wifi": 0.004,      "util_score_unknown_wifi": 0    }  ]}