SitesLocation
getSiteBeamCoverageOverview
Get Beam Coverage Overview
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
Format
uuidQuery Parameters
map_id?string
Filter results by map identifier
type?string
Filter results by type. enum: asset, client, sdkclient
Value in
- "asset"
- "client"
- "sdkclient"
client_type?string
Filter results by client type
duration?string
Time range duration for the query, using relative units such as 10m, 7d, or 2w
Default
"1d"resolution?string
Location calculation resolution used by the query. enum: default, fine
Default
"default"Value in
- "default"
- "fine"
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/location/coverage?map_id=00000000-0000-0000-0000-000000000000"{ "beams_means": [ [ 1, 3, 3.2 ], [ 6, 10, 6.5 ] ], "end": 1428954000, "gridsize": 1, "result_def": [ "x", "y", "beams_mean", "beacons_mean", "max_rssi", "avg_rssi" ], "results": [ [ 1, 3, 3.2, 18.5, -68, -70 ], [ 6, 10, 6.5, 30, 1, -72.5, -75 ] ], "start": 1428939600}