SitesStatsAssets

listSiteAssetsStats

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

List asset statistics for a site over the requested time range. Use List Org Asset Stats to retrieve 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

map_id?string

Filter assets by map UUID

Formatuuid
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

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/stats/assets"
[  {    "_ttl": 86400,    "battery_voltage": 3370,    "by": "asset",    "device_id": "00000000-0000-0000-1000-5c5b35000001",    "device_name": "BLE Device",    "eddystone_uid_instance": "5c5b35000001",    "eddystone_uid_namespace": "2818e3868dec25629ede",    "eddystone_url_url": "https://www.abc.com",    "ibeacon_major": 13,    "ibeacon_minor": 138,    "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",    "id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5",    "last_seen": 1480716946,    "mac": "4a0222000e31",    "manufacture": "Asset Manufacturer Name",    "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",    "mfg_company_id": 935,    "mfg_data": "648520a1020000",    "name": "Asset Name",    "rssi": -45,    "rssizones": [      {        "id": "478f6eca-6276-4993-bfeb-5bcbbbbacf08",        "since": 0      }    ],    "service_packets": [      {        "data": "640",        "last_rx_time": 1645855923,        "rx_cnt": 213065,        "uuid": "00003e10-0000-1000-8000-00805f9b34fb"      }    ],    "temperature": 23.5,    "x": 51,    "y": 29,    "zones": [      {        "id": "477f6eca-6276-4993-bfeb-5ccbbbbadf08",        "since": 0      }    ]  }]