Skip to content

WiFi Motion Core APIs (v3-x-x)

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.

Download OpenAPI description
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/

Network Settings

Operations

Motion History

Operations

Live Motion

Operations

Events

Operations

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Find by Node deviceId

Request

Security
ApiKey
Path
deviceidstringrequired
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/node/find/device/{deviceid}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/jsonArray [
idinteger(int64)required
network_idinteger(int64)required
shard_idinteger(int64)required
created_atnumber(float)

UTC timestamp

updated_atnumber(float)

UTC timestamp

ap_bssid_2ghzstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

ap_bssid_5ghzstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

mesh_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

gateway_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

p2p_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

deviceidstringrequired

IoT device name of Node

devicetypestringrequired

IoT device type of Node

tokenstringrequired

IoT access token

last_heardnumber(float)

UTC timestamp

last_statusobject or null

Last node status (deprecated)

connection_statusstring
Enum"OFFLINE""ONLINE"
connection_reportobject(IoTConnectionStatus)
metaobject(Root Type for NodeMetaConfig)

Additional meta-data attached to this radar node (friendly name, etc..)

Example: {}
]
Response
application/json
[ { "id": 0, "network_id": 0, "shard_id": 0, "created_at": 0.1, "updated_at": 0.1, "ap_bssid_2ghz": "string", "ap_bssid_5ghz": "string", "mesh_bssid": "string", "gateway_bssid": "string", "p2p_bssid": "string", "deviceid": "string", "devicetype": "string", "token": "string", "last_heard": 0.1, "last_status": {}, "connection_status": "OFFLINE", "connection_report": {}, "meta": {} } ]

Find by BSSID

Request

Checks all of: 2.4ghz AP BSSID, 5ghz AP BSSID, mesh BSSID, p2p BSSID

Security
ApiKey
Path
bssidintegerrequired

Locate node by Mesh peer BSSID

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/node/find/mac/{bssid}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/jsonArray [
idinteger(int64)required
network_idinteger(int64)required
shard_idinteger(int64)required
created_atnumber(float)

UTC timestamp

updated_atnumber(float)

UTC timestamp

ap_bssid_2ghzstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

ap_bssid_5ghzstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

mesh_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

gateway_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

p2p_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

deviceidstringrequired

IoT device name of Node

devicetypestringrequired

IoT device type of Node

tokenstringrequired

IoT access token

last_heardnumber(float)

UTC timestamp

last_statusobject or null

Last node status (deprecated)

connection_statusstring
Enum"OFFLINE""ONLINE"
connection_reportobject(IoTConnectionStatus)
metaobject(Root Type for NodeMetaConfig)

Additional meta-data attached to this radar node (friendly name, etc..)

Example: {}
]
Response
application/json
[ { "id": 0, "network_id": 0, "shard_id": 0, "created_at": 0.1, "updated_at": 0.1, "ap_bssid_2ghz": "string", "ap_bssid_5ghz": "string", "mesh_bssid": "string", "gateway_bssid": "string", "p2p_bssid": "string", "deviceid": "string", "devicetype": "string", "token": "string", "last_heard": 0.1, "last_status": {}, "connection_status": "OFFLINE", "connection_report": {}, "meta": {} } ]

Find (all) by Network ID

Request

Unlike the other Find by endpoints, this one returns an array.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/node/find/networkid/{network_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/jsonArray [
idinteger(int64)required
network_idinteger(int64)required
shard_idinteger(int64)required
created_atnumber(float)

UTC timestamp

updated_atnumber(float)

UTC timestamp

ap_bssid_2ghzstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

ap_bssid_5ghzstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

mesh_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

gateway_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

p2p_bssidstring(MachineAddress)

MAC in 00:11:22:33:44:55 format

deviceidstringrequired

IoT device name of Node

devicetypestringrequired

IoT device type of Node

tokenstringrequired

IoT access token

last_heardnumber(float)

UTC timestamp

last_statusobject or null

Last node status (deprecated)

connection_statusstring
Enum"OFFLINE""ONLINE"
connection_reportobject(IoTConnectionStatus)
metaobject(Root Type for NodeMetaConfig)

Additional meta-data attached to this radar node (friendly name, etc..)

Example: {}
]
Response
application/json
[ { "id": 0, "network_id": 0, "shard_id": 0, "created_at": 0.1, "updated_at": 0.1, "ap_bssid_2ghz": "string", "ap_bssid_5ghz": "string", "mesh_bssid": "string", "gateway_bssid": "string", "p2p_bssid": "string", "deviceid": "string", "devicetype": "string", "token": "string", "last_heard": 0.1, "last_status": {}, "connection_status": "OFFLINE", "connection_report": {}, "meta": {} } ]

Management

Operations