The Core APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. It offers interfaces for accessing topologies, events, motion data, and more.
Cognitive Systems App Core API
Device
A wireless client refers to any device that connects to a network using WiFi technology. For optimal performance with WiFi Sensing, stationary devices such as voice assistants (like Amazon Echo or Google Nest), smart plugs, smart displays, and powered wireless speakers are ideal choices. Wireless clients that are mobile can move around and generally have aggressive sleep modes, less reliable Channel State Information (CSI) data, and are not able to be used to help identify localization, all of which can impact the WiFi Motion performance.
Guardian
Guardian is the name of the application that runs on a device, such as an Access Point, WiFi Extender, or IoT device, within a WiFi Network. It's primary functions are to store configuration settings, communicate with WiFi devices within a network, and communicate with the WiFi Motion infrastructure.
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/version
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/version \
-H 'Authorization: YOUR_API_KEY_HERE'- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/v2/{network_id}/activity
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/v2/{network_id}/activity?start_time=0&end_time=0&flattened=false' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "first_bucket": 1743521400, "interval": 900, "data": [ 0, 0.559, 0.36765, 0.44425, null ] }
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/v2/{network_id}/sleep
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/v2/{network_id}/sleep?start_date=2025-03-20&end_date=2025-04-24&timezone=America%2FToronto' \
-H 'Authorization: YOUR_API_KEY_HERE'200 - OK
Household Sleep Time (HST) interruptions indicates the number of interruptions that had occurred during the sleep time.
Example: 3
The timestamp that indicates when the the household is considered to be asleep.
Example: "2025-03-19T22:00:00-04:00"
The timestamp that indicates when the household is considered to be awake.
Example: "2025-03-20T09:15:00-04:00"
A counter that tracks the day that is specific to the WiFi Motion network.
Example: 20166
Response
application/json
[ { "hst_interruptions": 3, "sleep_time": "2025-03-19T22:00:00-04:00", "wake_time": "2025-03-20T09:15:00-04:00", "timezone": "America/Toronto", "house_day": 20166 }, { "hst_interruptions": 0, "sleep_time": "2025-03-20T22:00:00-04:00", "wake_time": "2025-03-21T08:15:00-04:00", "timezone": "America/Toronto", "house_day": 20167 }, { "hst_interruptions": 0, "sleep_time": "2025-03-21T22:00:00-04:00", "wake_time": "2025-03-22T09:00:00-04:00", "timezone": "America/Toronto", "house_day": 20168 }, { "hst_interruptions": 0, "sleep_time": "2025-03-22T22:30:00-04:00", "wake_time": "2025-03-23T09:30:00-04:00", "timezone": "America/Toronto", "house_day": 20169 }, { "hst_interruptions": 0, "sleep_time": "2025-03-23T23:15:00-04:00", "wake_time": "2025-03-24T07:30:00-04:00", "timezone": "America/Toronto", "house_day": 20170 } ]
Generic
A webhook is an automated message sent from one app to another when a specific event occurs, like a payment or a code commit. It works by sending an HTTP request containing data (a "payload") to a unique URL provided by the receiving application. This allows for real-time data sharing and communication between applications without constant polling.