SitesStatsBeacons

listSiteBeaconsStats

GET
/api/v1/sites/{site_id}/stats/beacons

Get List of Site Beacons Stats

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

Query Parameters

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

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

application/json

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/stats/beacons"
[  {    "battery_voltage": 0,    "eddystone_instance": "string",    "eddystone_namespace": "string",    "last_seen": 1470417522,    "mac": "string",    "map_id": "09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1",    "name": "string",    "power": 0,    "type": "string",    "x": 0.1,    "y": 0.1  }]