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

Events

Operations

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Network motion-density histogram

Request

Retrieve time series array of motion-density values by location for network.

Security
ApiKey
Path
network_idintegerrequired

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

Query
frominteger

The UTC timestamp of the oldest report client already has in seconds

tointeger

The UTC timestamp of the latest report client is interested in, current time will be used if not provided

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/location/histogram?from=0&to=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
macstringrequired

Last 6 digits of hex mac

densitynumberrequired

Density of this device (0-1)

idinteger

node_id

iconstring

icon

namestring

Device (friendly) name

typestring(TopologyDeviceType)
Enum"MESH_ROOT""MESH_NODE""LEAF""CLIENT"
locationstring

Device location

mobileboolean

Indicates whether or not a location has been set for the device.

  • False The location is set.

  • True The location is not set.

]
Response
application/json
[
  {
    "density": 1,
    "mac": "a12b3c4d567e",
    "icon": "LEAF",
    "type": "LEAF",
    "id": -4,
    "name": "a12b3c4d567e",
    "location": "First Floor",
    "mobile": false
  }
]

[BETA] Device Motion Location History

Request

History of device motion density over a requested time window. Provides the friendly_name and / or location fields when they are set. Indicates whether the device is a NODE or LEAF. The results always include the mac address of the device.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID

Query
frominteger

UTC unix timestamp to search motion from. Defaults to 1 hour ago from a provided 'to'.

tointeger

UTC unix timestamp to query motion until. Defaults to now.

bucketinteger>= 5

Bucket size. Recommended use is 60.

Default 60
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/location/history?from=0&to=0&bucket=60' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 OK

Bodyapplication/json
locationsArray of objects(LocationHistoryByDevice)
Response
application/json
{
  "locations": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations