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
v3-x-x.json
v3-x-x.yaml
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 topology

Request

Security
ApiKey
Path
network_idintegerrequired

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

Query
offlineboolean

When true, returns offline devices (they will have online=false in their device description).

Default false
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/topology?offline=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
tsnumber(float)

UTC timestamp report was produced

devicesArray of objects(TopologyDevice)required

Device list

devices[].​idinteger

Unique device identifier

devices[].​namestring

Device identifier

devices[].​ipstring

Device local IP

devices[].​is_mesh_soundingboolean

Boolean if device is mesh sounding

devices[].​friendly_namestring

Device friendly name

devices[].​node_namestring

Name of AP this device is connected to

devices[].​locationstring

Device location

devices[].​typestring(TopologyDeviceType)
Enum"MESH_ROOT""MESH_NODE""LEAF""CLIENT"
devices[].​device_infoobject(Root Type for DeviceInfo)

Device info record

Example: {"device_type":"Google Streaming Dongle Chromecast","hostname":"Google-Home-Mini","mac":"f0:ef:86:63:03:73"}
devices[].​hw_platformstring

Device hardware platform

devices[].​macsArray of strings(MachineAddress)

List of MACs belonging to this device

devices[].​iconstring
Enum"DEFAULT""ORBI""GWIFI""NEST""TPLINK""LEAF"
devices[].​onlineboolean

true if the device is currently online

devices[].​mobileboolean

true if the device is presumed mobile

devices[].​is_staticstring

Link fixed vs mobile detection state

Enum"UNKNOWN""MOBILE""STATIC_NEW""STATIC"
devices[].​tx_enablestring

Keys are leaf macs, value is: "" - automatic sounding "1" - sounding forced enabled "0" - disabled

devices[].​sounding_statestring(LinkSoundingState)

Link sounding state

Enum"NONE""ACTIVE""SNEAKY"
linksArray of objects(TopologyLink)required

Device interconnect

links[].​src_idinteger

Unique device identifier of link source

links[].​dst_idinteger

Unique device identifier of link destination

links[].​motion_enabledboolean
links[].​detailobject(RadarNetworkLink)
links[].​sounding_statestring(LinkSoundingState)

Link sounding state

Enum"NONE""ACTIVE""SNEAKY"
Response
application/json
{
  "ts": 0.1,
  "devices": [
    { … }
  ],
  "links": [
    { … }
  ]
}

Delete network

Request

Security
ApiKey
Path
network_idintegerrequired

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

Query
annihilateboolean

If true, all nodes belonging to this network will also be deleted.

curl -i -X DELETE \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/edit?annihilate=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Network status

Request

Returns the most recent GuardianStatusReport from the network.

Security
ApiKey
Path
network_idintegerrequired

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

Query
keystring

Comma seperated list of keys to filter response on

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/status?key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
leafblowerobject

Leafblower Link Stats object, key is mac address

network_idinteger

Network numeric ID

shard_idstring

Network shard

radarsobject

map of radar id to radar status reports

tsnumber(float)required

UTC timestamp

last_motionnumber or null(float)

UTC timestamp of last motion refresh time

motion_trippedinteger

Motion detector current state (1 - tripped, 0 - no motion)

startupboolean

Is this the first report after startup

versionobject

Component version inside Guardian

healthobject

network and radar health

capabilitiesArray of strings

(alpha) list of device capabilities to unlock specify cloud options

coverageobject

Leafblower room coverage per node, key is node id, value is coverage array

guardian_idstring

Network guardian_id

dhcpobject

map of dhcp mac address and dhcp stats object - fused across all AP

motion_enabledinteger

Motion event generation state (1 - on, 0 - off)

armedinteger

Motion armed state (1 - on, 0 - off)

pausedboolean

When enabled, the system is in sounding paused mode, and no motion detection will be happening. The motion stack is in dormant mode until the sounding more is no longer paused.

Response
application/json
{
  "leafblower": {
    "property1": { … },
    "property2": { … }
  },
  "network_id": 0,
  "shard_id": "string",
  "radars": {
    "property1": { … },
    "property2": { … }
  },
  "ts": 0.1,
  "last_motion": 0.1,
  "motion_tripped": 0,
  "startup": true,
  "version": {
    "property1": "string",
    "property2": "string"
  },
  "health": {
    "nodes": { … },
    "network": 0
  },
  "capabilities": [
    "string"
  ],
  "coverage": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "guardian_id": "string",
  "dhcp": {
    "property1": { … },
    "property2": { … }
  },
  "motion_enabled": 0,
  "armed": 0,
  "paused": true
}

Network Meta

Operations

Location Data

Operations

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Gatekeeper

Operations

Management

Operations

Debug

Operations

Insights (Deprecated)

Operations