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

Config

Operations

Node

Operations

Gatekeeper

Operations

Management

Operations

Debug

Operations

Insights

Operations

Insights v2

Operations

[BETA] Sleep Insights

Request

[BETA] Sleep Insights provides you sleep related data, including the number of interruptions that have occurred and the sleep and wake times.

Path
network_idintegerrequired

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

Query
start_datestring(date)(Start Date)required

The first date to include within the results.

Example: start_date=2025-03-20
end_datestring(date)(End Date)required

The last date to include within the results.

Example: end_date=2025-04-24
timezonestring(string)(timezone)

Optional If set, the provided value will be used to perform end of day calculations.

Example: timezone=America/Toronto
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/insights/v2/{network_id}/sleep?end_date=2025-04-24&start_date=2025-03-20&timezone=America%2FToronto'

Responses

200 - OK

Bodyapplication/jsonArray [
hst_interruptionsinteger

Household Sleep Time (HST) interruptions indicates the number of interruptions that had occurred during the sleep time.

Example: 3
sleep_timestring(date-time)

The timestamp that indicates when the the household is considered to be asleep.

Example: "2025-03-19T22:00:00-04:00"
wake_timestring(date-time)

The timestamp that indicates when the household is considered to be awake.

Example: "2025-03-20T09:15:00-04:00"
timezonestring

Timezone used by the sleep and wake times.

Example: "America/Toronto"
house_dayinteger

A counter that tracks the day that is specific to the WiFi Motionâ„¢ network.

Example: 20166
]
Response
application/json
[ { "hst_interruptions": 3, "sleep_time": "2025-03-19T22:00:00-04:00", "wake_time": "2025-03-20T09:15:00-04:00", "timezone": "America/Toronto", "house_day": 20166 }, { "hst_interruptions": 0, "sleep_time": "2025-03-20T22:00:00-04:00", "wake_time": "2025-03-21T08:15:00-04:00", "timezone": "America/Toronto", "house_day": 20167 }, { "hst_interruptions": 0, "sleep_time": "2025-03-21T22:00:00-04:00", "wake_time": "2025-03-22T09:00:00-04:00", "timezone": "America/Toronto", "house_day": 20168 }, { "hst_interruptions": 0, "sleep_time": "2025-03-22T22:30:00-04:00", "wake_time": "2025-03-23T09:30:00-04:00", "timezone": "America/Toronto", "house_day": 20169 }, { "hst_interruptions": 0, "sleep_time": "2025-03-23T23:15:00-04:00", "wake_time": "2025-03-24T07:30:00-04:00", "timezone": "America/Toronto", "house_day": 20170 } ]

[BETA] Activity Insights

Request

[BETA] Provides a percentage of daily activity for the queried days. Please allow for a warmup period of between 2 and 4 hours after first being activated.

Path
network_idintegerrequired

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

Query
start_datestring(date)(Start Date)required

The first date to include within the results.

Example: start_date=2025-03-20
end_datestring(date)(End Date)required

The last date to include within the results.

Example: end_date=2025-04-24
timezonestring(string)(timezone)

Optional If set, the provided value will be used to perform end of day calculations.

Example: timezone=America/Toronto
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/insights/v2/{network_id}/activity/daily?end_date=2025-04-24&start_date=2025-03-20&timezone=America%2FToronto'

Responses

200 - OK

Bodyapplication/jsonArray [
datestring

Date that the results are related to.

percent_activenumber(float)

Percentage of time that activity occurred within the sample.

tsinteger

Epoch timestamp.

]
Response
application/json
[ { "date": "2025-03-19", "percent_active": 0.10266202688217163, "ts": 1742356800 }, { "date": "2025-03-20", "percent_active": 0.19775460163752237, "ts": 1742443200 }, { "date": "2025-03-21", "percent_active": 0.21174768606821695, "ts": 1742529600 }, { "date": "2025-03-22", "percent_active": 0.1452083388964335, "ts": 1742616000 } ]

Universal Alerting

Operations

Application Settings

Operations