SitesStatsIoT Endpoints

searchSiteIotEndpoints

GET
/api/v1/sites/{site_id}/iotendpoints/search

Search IoT Endpoints

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

ap_mac?string

Filter results by AP MAC address

mac?string

Filter results by MAC address

type?string

IoT endpoint type. enum: zigbee

mfg?string

Filter results by manufacturer

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
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"

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/iotendpoints/search"
{  "end": 1531862583,  "results": [    {      "ap_mac": "5c5b350e0001",      "id": "63f9e299182b63f9",      "lqi": 178,      "mac": "63f9e299182b63f9",      "mfg": "Assa Abloy",      "model": "Assa Abloy",      "timestamp": 1531782218,      "type": "zigbee"    }  ],  "start": 1531776183,  "total": 2}