The WiFi Motion Core Cloud APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. Additionally, it offers interfaces for accessing topologies, events, and motion data. The only difference is that the Core APIs do not specifically reference a user, and instead provide you with the ability to query the data from any network that is available in the environment.
WiFi Motion Core APIs (v3-x-x)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/
Request
Note: You will have to urlencode the query string here, use the library provided by your runtime.
Example queries where 'val' is a partial string match (use % as wildcard char):
meta->>'guardian_env'
(this will match the guardian_env key of the network meta blob)
meta->'dwm'->>'systemName'
(this will match the systemName key of the dwm object in the network meta blob)
Example query checking for existence of a field (omit val to directly execute):
meta->'dwm' \\? 'systemName'
Security
ApiKey
- Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/meta/{query}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/meta/{query}?val=string&array=false&expandNodes=false' \
-H 'Authorization: YOUR_API_KEY_HERE'
Response
application/json
[ { "last_guardian_status": { … }, "radar_config": { … }, "guardian_config": { … }, "created_at": 0.1, "updated_at": 0.1, "guardian_id": "string", "last_heard": 0.1, "meta": { … }, "master_node_id": 0, "shard_id": 0, "guardian_type": "string", "disconnected_at": 0.1, "nodes": [ … ], "id": 0, "connection_status": true, "connection_report": { … }, "device_info": { … } } ]
- Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/device/{guardian_deviceid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/device/{guardian_deviceid}?array=false&expandNodes=false' \
-H 'Authorization: YOUR_API_KEY_HERE'
Response
application/json
{ "last_guardian_status": { "leafblower": { … }, "network_id": 0, "shard_id": "string", "radars": { … }, "ts": 0.1, "last_motion": 0.1, "motion_tripped": 0, "startup": true, "version": { … }, "health": { … }, "capabilities": [ … ], "coverage": { … }, "guardian_id": "string", "dhcp": { … }, "motion_enabled": 0, "armed": 0, "paused": true }, "radar_config": { "dynamic_sensitivity": "string", "bridge": { … }, "motion80211": { … } }, "guardian_config": { "history_motion": { … }, "device_events": { … }, "live_motion": { … }, "link_events": { … }, "leafblower": { … }, "debug": { … }, "user_priority": [ … ], "motion_events": { … } }, "created_at": 0.1, "updated_at": 0.1, "guardian_id": "string", "last_heard": 0.1, "meta": { "dwm": { … }, "home": { … }, "location": { … }, "neuron_env": "string", "motion_paused": 0, "mqSecureRadarPort": 0, "auto_segment": 0, "guardian_env": "string", "friendly_name": { … }, "new_network_id": 0, "old_network_id": 0, "new_guardian_id": "string", "gatekeeper_redirect": "string", "property1": "string", "property2": "string" }, "master_node_id": 0, "shard_id": 0, "guardian_type": "string", "disconnected_at": 0.1, "nodes": [ { … } ], "id": 0, "connection_status": true, "connection_report": { "_id": "string", "category": "Link", "loc": [ … ], "detail": { … }, "link_dst_name": "string", "network_id": 0, "ts": 0.1, "evt_detected_ts": 0.1, "intensity_window": [ … ], "link_id": "string", "loc_name": "string", "tag": "string", "link_src_name": "string", "guardian_id": "string", "node_id": 0, "deviceId": "string", "node_name": "string", "debug": { … }, "armed": 0, "event": "MotionDetectedEvent", "_consumer": "string", "data": { … } }, "device_info": { "property1": { … }, "property2": { … } } }