SitesStatsAssets

searchSiteAssets

GET
/api/v1/sites/{site_id}/stats/assets/search

Search asset statistics for a site with filters for asset identifiers, device, map, beacon, AP, RSSI, and time range. Use Search Org Assets to search asset statistics across the organization.

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

mac?string

Filter results by MAC address

map_id?string

Filter results by map identifier

ibeacon_uuid?string

Filter asset results by iBeacon UUID

ibeacon_major?integer

Filter asset results by iBeacon major value

ibeacon_minor?integer

Filter asset results by iBeacon minor value

eddystone_uid_namespace?string

Filter asset results by Eddystone UID namespace

eddystone_uid_instance?string

Filter asset results by Eddystone UID instance

eddystone_url?string

Filter asset results by Eddystone URL

device_name?string

Filter asset results by reporting device name

by?string

Select how the value should be returned

name?string

Filter results by name

ap_mac?string

Filter asset results by reporting AP MAC address

beam?string

Filter asset results by beam value

rssi?string

Filter asset results by RSSI value

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"
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"
search_after?string

Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/stats/assets/search"
{  "end": 0,  "limit": 0,  "next": "string",  "results": [    {      "battery_voltage": 0,      "eddystone_uid_instance": "string",      "eddystone_uid_namespace": "string",      "eddystone_url_url": "string",      "ibeacon_major": 1,      "ibeacon_minor": 1,      "ibeacon_uuid": "1f89bc00-d0af-481b-82fe-a6629259a39f",      "last_seen": 0,      "mac": "string",      "map_id": "09d2b626-2e4e-45ef-a3c4-e6aeb6c83db1",      "name": "string",      "rssizones": [        {          "id": "476f6eca-6276-4993-bfeb-5dcbbbbaef08",          "since": 0        }      ],      "x": 0,      "y": 0,      "zones": [        {          "id": "475f6eca-6276-4993-bfeb-5ecbbbbf6f08",          "since": 0        }      ]    }  ],  "start": 0,  "total": 0}