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

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

Find by Node ID of Master

Request

Security

ApiKey

Path

master_idintegerrequired

ID of Master Radar Node

Query

arrayboolean

The default behavior is to return an array when there are multiple results and a single object in the case of a single result. When this parameter is true the response will always be an array.

Default false

expandNodesboolean

If true, will also return an array of all nodes belonging to this network under the 'nodes' key.

Default false

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/masterid/{master_id}?array=false&expandNodes=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

One of:

Array [

last_guardian_statusobject or null(GuardianStatusReport)

Status report emitted by the network on a regular interval. Contains information on the network's topology, health and motion detection metrics.

radar_configobject(RadarConfig)

Configuration that's shared by all Nodes in this Motion Network.

guardian_configobject(GuardianConfig)

Configuration for gateway or mesh root.

created_atnumber(float)required

UTC second timestamp of network creation.

updated_atnumber(float)required

UTC second timestamp of last configuration update.

guardian_idstringrequired

Unique network identifier. Populated by location_id on network creation.

last_heardnumber(float)

UTC timestamp of last guardian-status message.

metaobject(MetaConfig)

Network metadata storage.

master_node_idintegerrequired

Unique ID of gateway or mesh root node.

shard_idintegerrequired

Identifies the shard the network is stored in.

guardian_typestringrequired

String representation of network's shard in shard-shard-id format.

disconnected_atnumber(float)

UTC second timestamp of recorded disconnection.

nodesArray of objects(MotionNetworkRadarNode)

When expandNodes=true or in a configuration update context, the nodes part of this network are returned in this array.

idinteger(int64)required

Unique network integer identifier.

connection_statusboolean or null

Current connection status (null if has never been connected).

connection_reportobject or null(GuardianEvent)

device_infoobject

Mac-address keyed device info for all clients in this network.

]

Response

application/json

{
  "last_guardian_status": {
    "leafblower": { … },
    "network_id": 0,
    "shard_id": "string",
    "radars": { … },
    "ts": 0.1,
    "last_motion": 0,
    "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": { … }
  }
}

Find by Network ID

Request

Security

ApiKey

Path

network_idintegerrequired

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

Query

arrayboolean

The default behavior is to return an array when there are multiple results and a single object in the case of a single result. When this parameter is true the response will always be an array.

Default false

expandNodesboolean

If true, will also return an array of all nodes belonging to this network under the 'nodes' key.

Default false

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/id/{network_id}?array=false&expandNodes=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/jsonArray [

last_guardian_statusobject or null(GuardianStatusReport)

Status report emitted by the network on a regular interval. Contains information on the network's topology, health and motion detection metrics.

radar_configobject(RadarConfig)

Configuration that's shared by all Nodes in this Motion Network.

guardian_configobject(GuardianConfig)

Configuration for gateway or mesh root.

created_atnumber(float)required

UTC second timestamp of network creation.

updated_atnumber(float)required

UTC second timestamp of last configuration update.

guardian_idstringrequired

Unique network identifier. Populated by location_id on network creation.

last_heardnumber(float)

UTC timestamp of last guardian-status message.

metaobject(MetaConfig)

Network metadata storage.

master_node_idintegerrequired

Unique ID of gateway or mesh root node.

shard_idintegerrequired

Identifies the shard the network is stored in.

guardian_typestringrequired

String representation of network's shard in shard-shard-id format.

disconnected_atnumber(float)

UTC second timestamp of recorded disconnection.

nodesArray of objects(MotionNetworkRadarNode)

When expandNodes=true or in a configuration update context, the nodes part of this network are returned in this array.

idinteger(int64)required

Unique network integer identifier.

connection_statusboolean or null

Current connection status (null if has never been connected).

connection_reportobject or null(GuardianEvent)

device_infoobject

Mac-address keyed device info for all clients in this network.

]

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": { … }
  }
]

Find by BSSID

Request

Security

ApiKey

Path

bssidstringrequired

Access point BSSID

Query

arrayboolean

The default behavior is to return an array when there are multiple results and a single object in the case of a single result. When this parameter is true the response will always be an array.

Default false

expandNodesboolean

If true, will also return an array of all nodes belonging to this network under the 'nodes' key.

Default false

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/mac/{bssid}?array=false&expandNodes=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

Array of MotionNetwork (objects)

Response

application/json

[]

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations

WiFi Motion Core APIs (v3-x-x)

Network Settings

Motion History

Live Motion

Events

Insights v2

Universal Alerting

Network Status

Network Meta

Location Data

Find

Find by Node ID of Master

Request

Responses

Was this helpful?

Find by Network ID

Request

Responses

Was this helpful?

Find by BSSID

Request

Responses

Was this helpful?

Application Settings

Config

Node

Management