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

Config

Operations

Node

Operations

Gatekeeper

Operations

Management

Operations

Debug

Operations

Insights

Operations

Insights v2

Operations

Universal Alerting

Operations

Application Settings

Operations

Get application configuration by network ID

Request

Retrieves the application configuration settings for a specified network.

Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/application/settings'

Responses

Application configuration retrieved successfully

Bodyapplication/json
timezonestring

Timezone configuration

enabledboolean

Sleep settings enasbled or desabled

sleep_hourinteger

Sleep hour in sleep settings

sleep_minuteinteger

Sleep minute in sleep settings

wake_hourinteger

Wake hour in sleep settings

wake_minuteinteger

Wake minute in sleep settings

Response
application/json
{
  "timezone": "string",
  "enabled": true,
  "sleep_hour": 0,
  "sleep_minute": 0,
  "wake_hour": 0,
  "wake_minute": 0
}

Create a new application configuration

Request

Creates a new application configuration entry for a specific network with schedule settings and timezone.

Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

Bodyapplication/jsonrequired

Application configuration object that needs to be created

timezonestring

Timezone configuration

enabledboolean

Sleep settings enasbled or desabled

sleep_hourinteger

Sleep hour in sleep settings

sleep_minuteinteger

Sleep minute in sleep settings

wake_hourinteger

Wake hour in sleep settings

wake_minuteinteger

Wake minute in sleep settings

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/application/settings' \
  -H 'Content-Type: application/json' \
  -d '{
    "timezone": "UTC",
    "enabled": true,
    "sleep_hour": 23,
    "sleep_minute": 0,
    "wake_hour": 7,
    "wake_minute": 0
  }'

Responses

Configuration created successfully

Update an application configuration

Request

Updates an existing application configuration with provided fields. Only supplied fields will be updated.

Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

Bodyapplication/jsonrequired

Application configuration fields to update

timezonestring

Timezone configuration

enabledboolean

Sleep settings enasbled or desabled

sleep_hourinteger

Sleep hour in sleep settings

sleep_minuteinteger

Sleep minute in sleep settings

wake_hourinteger

Wake hour in sleep settings

wake_minuteinteger

Wake minute in sleep settings

curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/application/settings' \
  -H 'Content-Type: application/json' \
  -d '{
    "timezone": "UTC",
    "enabled": true,
    "sleep_hour": 23,
    "sleep_minute": 0,
    "wake_hour": 7,
    "wake_minute": 0
  }'

Responses

Configuration updated successfully