openapi: 3.2.0 info: title: Mist Sites Stats - Assets API description: '> Version: **2607.1.1** > > Date: **August 17, 2026** NOTE: Some important API changes will be introduced.' contact: name: Thomas Munzer email: tmunzer@juniper.net version: 2607.1.1 servers: - url: https://api.mist.com variables: {} - url: https://api.gc1.mist.com variables: {} - url: https://api.ac2.mist.com variables: {} - url: https://api.gc2.mist.com variables: {} - url: https://api.gc4.mist.com variables: {} - url: https://api.eu.mist.com variables: {} - url: https://api.gc3.mist.com variables: {} - url: https://api.ac6.mist.com variables: {} - url: https://api.gc6.mist.com variables: {} - url: https://api.ac5.mist.com variables: {} - url: https://api.gc5.mist.com variables: {} - url: https://api.gc7.mist.com variables: {} security: - apiToken: [] - csrfToken: [] tags: - name: Sites Stats - Assets paths: /api/v1/sites/{site_id}/stats/assets: parameters: [] get: tags: - Sites Stats - Assets summary: listSiteAssetsStats description: List asset statistics for a site over the requested time range. Use List Org Asset Stats to retrieve asset statistics across the organization. operationId: listSiteAssetsStats parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: map_id in: query description: Filter assets by map UUID style: form explode: true schema: type: string contentEncoding: uuid - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: page in: query description: Select the page number to return when using page-based pagination; starts at `1` style: form explode: true schema: minimum: 1 type: integer contentEncoding: int32 default: 1 responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/stats_asset' description: Asset statistics returned by the request examples: - - _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 contentMediaType: application/json examples: Example: value: - _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 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/stats_asset' description: Asset statistics returned by the request examples: - - _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 contentMediaType: application/vnd.api+json examples: Example: value: - _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 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/assets/count: parameters: [] get: tags: - Sites Stats - Assets summary: countSiteAssets description: Count by Distinct Attributes of Site Asset operationId: countSiteAssets parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: distinct in: query description: 'Field used to group this count response. enum: `by`, `device_name`, `eddystone_uid_instance`, `eddystone_uid_namespace`, `eddystone_url`, `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `name`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/site_assets_count_distinct' - description: 'Field used to group this count response. enum: `by`, `device_name`, `eddystone_uid_instance`, `eddystone_uid_namespace`, `eddystone_url`, `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `name`' - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 responses: '200': description: Result of Count headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results examples: - distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 contentMediaType: application/json examples: Example: value: distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results examples: - distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 contentMediaType: application/vnd.api+json examples: Example: value: distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/assets/search: parameters: [] get: tags: - Sites Stats - Assets summary: searchSiteAssets description: 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. operationId: searchSiteAssets parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: mac in: query description: Filter results by MAC address style: form explode: true schema: type: string examples: - '001122334455' - name: map_id in: query description: Filter results by map identifier style: form explode: true schema: type: string examples: - b069b358-4c97-5319-1f8c-7c5ca64d6ab1 - name: ibeacon_uuid in: query description: Filter asset results by iBeacon UUID style: form explode: true schema: type: string examples: - 3ce2ef69-4414-469d-9d55-3ec7fcc38520 - name: ibeacon_major in: query description: Filter asset results by iBeacon major value style: form explode: true schema: type: integer contentEncoding: int32 examples: - 1 - name: ibeacon_minor in: query description: Filter asset results by iBeacon minor value style: form explode: true schema: type: integer contentEncoding: int32 examples: - 1 - name: eddystone_uid_namespace in: query description: Filter asset results by Eddystone UID namespace style: form explode: true schema: type: string examples: - 1234567890abcdef1234567890abcdef - name: eddystone_uid_instance in: query description: Filter asset results by Eddystone UID instance style: form explode: true schema: type: string examples: - 1234567890abcdef1234567890abcdef - name: eddystone_url in: query description: Filter asset results by Eddystone URL style: form explode: true schema: type: string examples: - https://example.com - name: device_name in: query description: Filter asset results by reporting device name style: form explode: true schema: type: string examples: - Device Name - name: by in: query description: Select how the value should be returned style: form explode: true schema: type: string examples: - mac - name: name in: query description: Filter results by name style: form explode: true schema: type: string examples: - Asset Name - name: ap_mac in: query description: Filter asset results by reporting AP MAC address style: form explode: true schema: type: string examples: - '001122334455' - name: beam in: query description: Filter asset results by beam value style: form explode: true schema: type: string examples: - '0' - name: rssi in: query description: Filter asset results by RSSI value style: form explode: true schema: type: string - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: sort in: query description: On which field the list should be sorted, -prefix represents DESC order style: form explode: true schema: type: string default: timestamp examples: - -site_id - name: search_after in: query description: 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. style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_stats_assets' - description: Paginated response for asset statistics search results examples: - 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 contentMediaType: application/json examples: Example: value: 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 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_stats_assets' - description: Paginated response for asset statistics search results examples: - 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 contentMediaType: application/vnd.api+json examples: Example: value: 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 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/assets/{asset_id}: parameters: [] get: tags: - Sites Stats - Assets summary: getSiteAssetStats description: Get Site Asset Details operationId: getSiteAssetStats parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: asset_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/stats_asset' - description: BLE asset location and advertisement statistics examples: - _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: 480f6eca-6276-4993-bfeb-59cbbbbaaf08 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: 479f6eca-6276-4993-bfeb-5acbbbbabf08 since: 0 contentMediaType: application/json examples: Example: value: _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: 480f6eca-6276-4993-bfeb-59cbbbbaaf08 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: 479f6eca-6276-4993-bfeb-5acbbbbabf08 since: 0 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/stats_asset' - description: BLE asset location and advertisement statistics examples: - _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: 480f6eca-6276-4993-bfeb-59cbbbbaaf08 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: 479f6eca-6276-4993-bfeb-5acbbbbabf08 since: 0 contentMediaType: application/vnd.api+json examples: Example: value: _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: 480f6eca-6276-4993-bfeb-59cbbbbaaf08 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: 479f6eca-6276-4993-bfeb-5acbbbbabf08 since: 0 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/discovered_assets: parameters: [] get: tags: - Sites Stats - Assets summary: listSiteDiscoveredAssets description: Get List of Site Discovered BLE Assets that doesn’t match any of the Asset / Assetfilters operationId: listSiteDiscoveredAssets parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: page in: query description: Select the page number to return when using page-based pagination; starts at `1` style: form explode: true schema: minimum: 1 type: integer contentEncoding: int32 default: 1 responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/asset' description: List of named BLE asset records contentMediaType: application/json '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/filtered_assets: parameters: [] get: tags: - Sites Stats - Assets summary: getSiteAssetsOfInterest description: Get a list of BLE beacons that matches Asset or AssetFilter operationId: getSiteAssetsOfInterest parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: page in: query description: Select the page number to return when using page-based pagination; starts at `1` style: form explode: true schema: minimum: 1 type: integer contentEncoding: int32 default: 1 responses: '200': description: Example response headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/asset_of_interest' description: BLE beacons that matched named assets or asset filters examples: - - ap_mac: string beam: 0 by: string curr_site: string device_name: string id: string last_seen: 0 mac: string manufacture: string map_id: string name: string rssi: 0 contentMediaType: application/json examples: Example: value: - ap_mac: string beam: 0 by: string curr_site: string device_name: string id: string last_seen: 0 mac: string manufacture: string map_id: string name: string rssi: 0 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/asset_of_interest' description: BLE beacons that matched named assets or asset filters examples: - - ap_mac: string beam: 0 by: string curr_site: string device_name: string id: string last_seen: 0 mac: string manufacture: string map_id: string name: string rssi: 0 contentMediaType: application/vnd.api+json examples: Example: value: - ap_mac: string beam: 0 by: string curr_site: string device_name: string id: string last_seen: 0 mac: string manufacture: string map_id: string name: string rssi: 0 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/maps/{map_id}/discovered_assets: parameters: [] get: tags: - Sites Stats - Assets summary: getSiteDiscoveredAssetByMap description: Get a list of BLE beacons that we discovered (whether they’ re defined as assets or not) operationId: getSiteDiscoveredAssetByMap parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: map_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/stats_asset' description: Asset statistics returned by the request contentMediaType: application/json '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false components: schemas: response_http403: title: response_http403 type: object properties: detail: type: string description: Human-readable explanation of the permission error examples: - You do not have permission to perform this action. description: Standard HTTP 403 permission error response count_result: title: count_result required: - count type: object properties: count: type: integer description: Number of matching items for the distinct value or values in this result contentEncoding: int32 additionalProperties: type: string description: Count result row with the matching distinct field values response_stats_assets: title: response_stats_assets required: - end - limit - results - start - total type: object properties: end: type: integer description: Epoch timestamp, in seconds, for the end of the asset statistics search window contentEncoding: int32 limit: type: integer description: Maximum number of asset statistics records returned in this page contentEncoding: int32 next: type: string description: URL for retrieving the next page of asset statistics results results: type: array items: $ref: '#/components/schemas/stats_asset' description: Asset statistics records matching the search filters start: type: integer description: Epoch timestamp, in seconds, for the start of the asset statistics search window contentEncoding: int32 total: type: integer description: Number of asset statistics records matching the search filters across all pages contentEncoding: int32 description: Paginated response for asset statistics search results response_http400: title: response_http400 type: object properties: detail: type: string description: Human-readable explanation of the bad request error examples: - 'JSON parse error - Expecting value: line 5 column 8 (char 56)' description: Standard HTTP 400 bad request error response response_http404: title: response_http404 type: object properties: id: type: string description: Missing resource identifier, when the API includes one description: Standard HTTP 404 not found error response asset_of_interest: title: asset_of_interest type: object properties: ap_mac: minLength: 1 type: string description: Access point MAC address that heard this BLE beacon beam: type: number description: BLE beam number that detected this beacon by: minLength: 1 type: string description: Match source for this BLE beacon, such as asset or asset filter curr_site: minLength: 1 type: string description: Site currently associated with this BLE beacon device_name: type: string description: AP name reported for the device that heard this BLE beacon id: type: string description: Unique identifier of the matched asset or filter entry contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f last_seen: type: - number - 'null' description: Timestamp when this BLE beacon was last observed readOnly: true examples: - 1470417522 mac: minLength: 1 type: string description: Bluetooth MAC address of this BLE beacon manufacture: minLength: 1 type: string description: BLE manufacturer name resolved for this beacon map_id: minLength: 1 type: string description: Identifier of the map associated with this BLE beacon observation name: minLength: 1 type: string description: Display name of the matched asset or filter rssi: type: number description: Signal strength of this BLE beacon, in dBm description: BLE beacon that matched a named asset or asset filter response_count: title: response_count required: - distinct - end - limit - results - start - total type: object properties: distinct: type: string description: Field used to group the count results end: type: integer description: Search window end timestamp for the count request, in epoch seconds contentEncoding: int32 limit: type: integer description: Maximum number of distinct count results requested contentEncoding: int32 results: uniqueItems: true type: array items: $ref: '#/components/schemas/count_result' description: Count results grouped by the distinct field start: type: integer description: Search window start timestamp for the count request, in epoch seconds contentEncoding: int32 total: type: integer description: Number of distinct result buckets returned contentEncoding: int32 description: Distinct count response for time-bounded search results site_assets_count_distinct: title: site_assets_count_distinct enum: - by - device_name - eddystone_uid_instance - eddystone_uid_namespace - eddystone_url - ibeacon_major - ibeacon_minor - ibeacon_uuid - mac - map_id - name type: string description: 'enum: `by`, `device_name`, `eddystone_uid_instance`, `eddystone_uid_namespace`, `eddystone_url`, `ibeacon_major`, `ibeacon_minor`, `ibeacon_uuid`, `mac`, `map_id`, `name`' stats_asset: title: stats_asset required: - mac type: object properties: _ttl: type: integer description: Time-to-live in seconds; how long this asset data is valid in cache contentEncoding: int32 battery_percent: type: integer description: Estimated battery level (1–100%); currently supported for Aruba/HPE asset tags contentEncoding: int32 examples: - 50 battery_voltage: type: number description: Battery voltage, in mV examples: - 2970 beam: type: integer description: BLE beam number where the asset was observed contentEncoding: int32 examples: - 6 by: type: string description: Observation source type for the asset statistic examples: - asset device_id: type: string description: Device ID of the loudest AP contentEncoding: uuid readOnly: true examples: - 00000000-0000-0000-1000-5c5b35000001 device_name: type: string description: Display name of the loudest AP observing the asset examples: - a duration: type: integer description: Length of the current asset observation, in seconds contentEncoding: int32 examples: - 120 eddystone_uid_instance: type: string description: Eddystone-UID instance value advertised by the asset examples: - 5c5b35000001 eddystone_uid_namespace: type: string description: Eddystone-UID namespace value advertised by the asset examples: - 2818e3868dec25629ede eddystone_url_url: type: string description: URL value advertised by the asset through Eddystone-URL examples: - https://www.abc.com ibeacon_major: maximum: 65535 minimum: 1 type: - integer - 'null' description: iBeacon major value advertised by the asset contentEncoding: int32 examples: - 1234 ibeacon_minor: maximum: 65535 minimum: 1 type: - integer - 'null' description: iBeacon minor value advertised by the asset contentEncoding: int32 examples: - 1234 ibeacon_uuid: type: - string - 'null' description: iBeacon UUID advertised by the asset contentEncoding: uuid examples: - f3f17139-704a-f03a-2786-0400279e37c3 id: type: string description: Unique identifier for the asset statistic contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f last_seen: type: - number - 'null' description: Time when the BLE asset was last observed, in epoch seconds readOnly: true examples: - 1470417522 mac: type: string description: Bluetooth MAC address for the asset examples: - 6fa474be7ae5 manufacture: type: string description: Vendor name resolved from the BLE manufacturer company ID map_id: type: string description: Map where the device belongs to contentEncoding: uuid examples: - c45be59f-854d-4ef7-b782-dcd6309c84a9 mfg_company_id: type: integer description: BLE manufacturer company ID from advertisement contentEncoding: int32 examples: - 935 mfg_data: type: string description: Manufacturer-specific data (hex encoded) examples: - 648520a1020000 name: type: string description: Display label for the BLE asset examples: - 6fa474be7ae5 rssi: type: integer description: Signal strength (RSSI) of the loudest AP in dBm contentEncoding: int32 examples: - -60 rssizones: type: array items: $ref: '#/components/schemas/asset_rssi_zone' description: RSSI zones currently containing this asset service_packets: maxItems: 10 type: array items: $ref: '#/components/schemas/stats_asset_service_packet' description: Service data advertisements observed from this asset temperature: type: number description: Reported temperature value from the BLE asset examples: - 23 x: type: number description: Map X coordinate of the asset location, in pixels examples: - 280.19918140310193 y: type: number description: Map Y coordinate of the asset location, in pixels examples: - 420.2987721046529 zones: type: array items: $ref: '#/components/schemas/asset_zone' description: Map zones currently containing this asset description: BLE asset location and advertisement statistics response_http429: title: response_http429 type: object properties: detail: type: string description: Human-readable explanation of the rate limit error examples: - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold description: Standard HTTP 429 rate limit error response asset: title: asset required: - mac - name type: object properties: created_time: type: number description: Timestamp when this asset record was created readOnly: true for_site: type: boolean description: Whether this asset is scoped directly to a site readOnly: true id: type: string description: Unique identifier of the asset record contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f mac: type: string description: Bluetooth MAC address used to identify the BLE asset map_id: type: string description: Identifier of the map associated with this asset, when specified contentEncoding: uuid modified_time: type: number description: Timestamp when this asset record was last modified readOnly: true name: type: string description: Display name or label for the BLE asset org_id: type: string description: Owning organization identifier for this asset contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 site_id: type: string description: Identifier of the site associated with this asset contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 tag_id: type: string description: BLE tag identifier associated with this asset contentEncoding: uuid description: Named Bluetooth Low Energy asset record asset_zone: title: asset_zone type: object properties: id: type: string description: Unique identifier of the zone contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f since: type: number description: Timestamp when the asset entered this zone description: Map zone membership for an individual asset statistic stats_asset_service_packet: title: stats_asset_service_packet type: object properties: data: type: string description: Service data payload (hex encoded) examples: - '640' last_rx_time: type: integer description: Unix timestamp when this service data was last received contentEncoding: int32 examples: - 1645855923 rx_cnt: type: integer description: Total number of times this service data was received contentEncoding: int32 examples: - 213065 uuid: type: string description: BLE service UUID advertised by the asset service packet examples: - 00003e10-0000-1000-8000-00805f9b34fb description: Service data advertisement from a BLE asset asset_rssi_zone: title: asset_rssi_zone type: object properties: id: type: string description: Unique identifier of the RSSI zone contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f since: type: number description: Timestamp when the asset entered this RSSI zone description: RSSI zone membership for an individual asset statistic response_http401: title: response_http401 type: object properties: detail: type: string description: Human-readable explanation of the authentication error examples: - Authentication credentials were not provided. description: Standard HTTP 401 authentication error response securitySchemes: apiToken: type: apiKey description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed." name: Authorization in: header csrfToken: type: apiKey description: 'Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session. **Format**: ``` X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx ``` For automation, API Token authentication is preferred.' name: X-CSRFToken in: header