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
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

Detailed live motion

Request

Opens connection to stream live motion data from the network. The websocket will stream motion data updates live from the network until closed.

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/network/{network_id}/motion/live' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
countnumber

Number of samples (number of strides in the inner data dimension) - always 1

locArray of strings

The first entry is a string representing the MAC addresses near which motion has been localized. If present, the second entry is p_confidence a float representing how sure the algorithm is of its decision.

loc_namestring

User indicated location of the device being localized to in loc field (if provided, empty string otherwise)

loc_confArray of numbers

The location confidence information as an array of number (float) for the corresponding loc output index. Available as debug output values when Guardian Config -> live_motion -> loc_conf_enable = 1. Supported as of GuardianCore = 0.7.2

linksArray of strings(LinkId)

Array of link IDs (outer data dimension). Format is dst_mac-src_mac

intervalnumber

Milliseconds/sample (stride time of inner data dimension) - always 500ms

tsnumber(float)

Timestamp of the first sample in the stream (start time of inner data dimension)

last_motionnumber(float)

UTC timestamp

dataobject

Data fields as 2D arrays

Response
application/json
{
  "ts": 1749733674.23,
  "links": [
    "csi-b-a01b23345678.012ab345c678",
    "csi-b-a01b23345678.012ab345c67d",
    "csi-b-a01b23345678.a1234b5c67de"
  ],
  "data": {
    "lraw": [ … ],
    "mconf": [ … ],
    "mkai": [ … ],
    "msad": [ … ],
    "throughput": [ … ]
  },
  "loc": [
    "nomotion"
  ],
  "interval": 500,
  "count": 1,
  "last_motion": 1749730197.74
}

PubNub start

Request

Security
ApiKey
Path
network_idintegerrequired

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

Bodyapplication/json
subscribeKeystringrequired
publishKeystringrequired
authKeystringrequired
channelstringrequired
ttlinteger

If not refreshed after this many seconds the publishing will automatically cease.

Default 300
curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/motion/pubnub' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscribeKey": "string",
    "publishKey": "string",
    "authKey": "string",
    "channel": "string",
    "ttl": 300
  }'

Responses

OK.

Bodyapplication/json
statusinteger
successinteger
Response
application/json
{
  "status": 0,
  "success": 0
}

Motion stream start

Request

Security
ApiKey
Path
network_idintegerrequired

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

Bodyapplication/json
ttlinteger

If not refreshed after this many seconds the publishing will automatically cease.

Default 120
curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/motion/refresh' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ttl": 120
  }'

Responses

OK.

Bodyapplication/json
statusinteger
successinteger
Response
application/json
{
  "status": 0,
  "success": 0
}

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

Management

Operations