getSiteBeamCoverageOverview
GET https://{{host}}/api/v1/sites/:site_id/location/coverage?map_id={{map_id}}&type&duration&resolution&client_type
#### Query Parameter Parameter|Type|Description :-------------: |:-------------: |:-------------: duration|string|1d, 30m, 5h, where the start time will be calculated (with end time is now), default is 1h type|string|sdkclient / client / asset, default is sdkclient mapid|string|mapid (filter by mapid) resolution|string|default / fine clienttype|string|client_type (as filter. optional)
#### Response Parameter Parameter|Type|Description :-------------: |:-------------: |:-------------: beamsmeans|list|list of [x, y, mean]s, x/y are in meters (UI would need to use map.ppm to calulate the pixel location from top-left). gridsize|float|the size of grid, in meter results|list|list of results, see resultdef. result_def|list|list of names annotating the fields in results
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
map_id | string | ||
type | null | ||
duration | null | ||
resolution | null | ||
client_type | null |