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. This documentation outlines the endpoints for engaging with the WiFi Motion cloud and includes specifications for the following APIs:

Network Settings

Motion History

The motion history APIs provide various historical motion metrics.

Live Motion

The live motion API opens a web socket and triggers the network to emit recorded motion at a 500ms interval.

Events

The events APIs allow you to retrieve, create or tag events emitted by the network.

Network Status

High-level APIs for retrieving the network's topology, last status message, or to view or modify the network's metadata.

Location Data

The location data APIs expose localized motion data. Localization happens on a per mac, or custom location name base.

Find

A set of APIs to find a network in the WiFi Motion Cloud. Individual, or groups of networks can be queried by their primary identifiers or by MAC.

Insights (advanced)

APIs of the internal Home Insights Microservice. Used for motion-based activity and sleep insights.

Config (advanced)

Fine-grained network configuration. These APIs give full access to the underlying motion detection controls, but have no safeguards to prevent unwanted side effects. For friendlier configuration management, see the Network Settings APIs.

Node (advanced)

Interface to manage the access point or mesh nodes of a network. Provides APIs to find, delete or alter the configuration of nodes.

Gatekeeper (advanced)

Endpoint used by WiFi Motion agent for the initial cloud connection. This API returns credentials for connecting to the MQTT broker and stores the initial network configuration. We don't recommend using this API directly.

Management (advanced)

Execute commands directly on the network's access point, or on a mesh node. We recommend using the NOC Management Page for these actions.

Debug (advanced)

Debug endpoints, for internal use only.

Application Settings (advanced)

The application settings API allows users to create, update, delete, and retrieve configurations based on network ID.

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

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Find by Meta field

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'

Path
querystringrequired

Guardian device ID

Query
valstring

Value to search for

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/meta/{query}?array=false&expandNodes=false&val=string'

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(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 Guardian deviceId

Request

Path
guardian_deviceidstringrequired

Guardian device ID

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/device/{guardian_deviceid}?array=false&expandNodes=false'

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

List networks

Request

Query
countinteger

Number of networks to return in one call.

Default 10
lastIdinteger

Determines the current position of the pagination cursor. When used, the resulting return set will contain networks whose network id's are greater (non-inclusive) then the value provided. If combined with a order value of "desc" the return will be networks whose ids are less then (non-inclusive) the value provided.

A value of -1 (Default) will return the start or end of the dataset depending on the value of the order parameter

Default -1
expandNodesboolean

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

Default false
orderstring

Determines the sorting order of the returned result. This param accepts a string value of either "asc" or "desc". The default behavior if omitted is "asc".

Default "asc"
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/find/all/all?count=10&expandNodes=false&lastId=-1&order=asc'

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

Config

Operations

Node

Operations

Gatekeeper

Operations

Management

Operations

Debug

Operations

Insights

Operations

Insights v2

Operations

Universal Alerting

Operations

Application Settings

Operations