Skip to content

Cognitive Systems App Core API

The Core APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. It offers interfaces for accessing topologies, events, motion data, and more.

Download OpenAPI description
core.json
core.yaml
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/core

Cloud Health

Provides you with the ability to check the health of the Cloud environment.

Operations

Network

A WiFi Motion network is a typical network which would include WiFi connected devices, client devices, and also at least one WiFi Motion enabled device, such as an Access Point, Extender, or WiFi plug.

Operations

Meta

Allows you to store and retrieve meta data related to your WiFi Motion Network and connected devices.

Operations

Application Settings

Provides you with a method to be able to retrieve application or user settings within a WiFi Motion network.

Operations

Get application configuration by network ID

Request

Retrieves the application configuration settings for a specified network.

Security
ApiKey
Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/application/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Application configuration retrieved successfully

Bodyapplication/json
network_idinteger

The Network ID is a unique identifier that is assigned to a WiFi Motion network when it is created. The Network ID is used by applications such as AppCloud, Device Manager, and via APIs, to uniquely identify a network.

timezonestring

Timezone configuration

enabledboolean

The sleep settings enabled or disabled.

true Sleep settings are enabled

false Sleep settings are not enabled

sleep_hourinteger[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household initiates their sleeping pattern.

sleep_minuteinteger[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household initiates their sleeping pattern.

wake_hourinteger[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household ends their sleeping pattern.

wake_minuteinteger[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household ends their sleeping pattern.

created_atstring

The date and time that the Application Settings were initiated created.

updated_atstring

The date and time that the Application Settings were last updated.

enabled_atstring or null

The date and time when the Application Settings were enabled. If the application settings are not enabled, then a value of null will be provided.

presencestring

Current home/away based on door sensor events.

Default "away"
presence_away_window_secondsinteger

How long after the door sensor should we check when home, if the user has left.

Default 300
presence_away_delay_secondsinteger

How long should we allow for people to leave when home.

Default 60
presence_home_window_secondsinteger

How long after the door sensor detect should we check when away

Default 300
presence_detection_enabledboolean

Switch home/away based on door sensor

Default true
pia_enabledboolean

Are prolonged inactivity alerts enabled

Default true
pia_escalation_stepinteger

Current escalation step, don’t change this manually via API.

Default 0
pia_escalation_threshold_secondsinteger

Time between steps

Default 3600
pia_wake_time_plus_secondsinteger

How long to wait after wake_time to watch for Prolonged Inactivity Alert

Default 3600
pia_sleep_time_minus_secondsinteger

How long to wait before sleep_time to watch for Prolonged Inactivity Alert

Default 3600
Response
application/json
{
  "network_id": 123,
  "timezone": "America/New_York",
  "enabled": true,
  "sleep_hour": 22,
  "sleep_minute": 30,
  "wake_hour": 6,
  "wake_minute": 30,
  "created_at": "2025-03-26T03:32:58.000Z",
  "updated_at": "2025-04-08T16:25:07.709Z",
  "enabled_at": "2025-03-26T03:32:58.000Z"
}

Create a new application configuration

Request

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

Security
ApiKey
Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

Bodyapplication/jsonrequired

Application configuration object that needs to be created

network_idinteger(network_id)

The Network ID is a unique identifier that is assigned to a WiFi Motion network when it is created. The Network ID is used by applications such as AppCloud, Device Manager, and via APIs, to uniquely identify a network.

timezonestring(timezone)

Timezone configuration

enabledboolean(enabled)

The sleep settings enabled or disabled.

true Sleep settings are enabled

false Sleep settings are not enabled

sleep_hourinteger(sleep_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household initiates their sleeping pattern.

sleep_minuteinteger(sleep_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household initiates their sleeping pattern.

wake_hourinteger(wake_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household ends their sleeping pattern.

wake_minuteinteger(wake_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household ends their sleeping pattern.

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/application/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 0,
    "timezone": "string",
    "enabled": true,
    "sleep_hour": 23,
    "sleep_minute": 59,
    "wake_hour": 23,
    "wake_minute": 59
  }'

Responses

Configuration created successfully

Bodyapplication/json
Response
application/json
{
  "message": "Configuration created successfully",
  "data": {
    "network_id": 123,
    "timezone": "America/New_York",
    "enabled": true,
    "sleep_hour": 22,
    "sleep_minute": 30,
    "wake_hour": 6,
    "wake_minute": 30,
    "created_at": "2025-06-17T18:44:01.674Z",
    "updated_at": "2025-06-17T18:44:01.674Z",
    "enabled_at": "2025-06-17T18:44:01.674Z"
  }
}

Update an application configuration

Request

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

Examples:

Security
ApiKey
Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

Bodyapplication/jsonrequired

Application configuration fields to update

network_idinteger(network_id)

The Network ID is a unique identifier that is assigned to a WiFi Motion network when it is created. The Network ID is used by applications such as AppCloud, Device Manager, and via APIs, to uniquely identify a network.

timezonestring(timezone)

Timezone configuration

enabledboolean(enabled)

The sleep settings enabled or disabled.

true Sleep settings are enabled

false Sleep settings are not enabled

sleep_hourinteger(sleep_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household initiates their sleeping pattern.

sleep_minuteinteger(sleep_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household initiates their sleeping pattern.

wake_hourinteger(wake_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household ends their sleeping pattern.

wake_minuteinteger(wake_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household ends their sleeping pattern.

curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/application/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 0,
    "timezone": "string",
    "enabled": true,
    "sleep_hour": 23,
    "sleep_minute": 59,
    "wake_hour": 23,
    "wake_minute": 59
  }'

Responses

Configuration updated successfully

Bodyapplication/json
Response
application/json
{
  "message": "Configuration updated successfully",
  "data": {
    "network_id": 369,
    "timezone": "America/New_York",
    "enabled": true,
    "sleep_hour": 22,
    "sleep_minute": 30,
    "wake_hour": 6,
    "wake_minute": 30,
    "created_at": "2025-06-17T18:51:22.140Z",
    "updated_at": "2025-06-17T19:02:23.869Z",
    "enabled_at": "2025-06-17T19:02:23.869Z"
  }
}

Sounding

Sounding is the terminology used to describe the process of receiving the Channel State Information (CSI) data from a wireless device, analyzing the data, and evaluating if motion had occurred in the environment.

Operations

Device

A wireless client refers to any device that connects to a network using WiFi technology. For optimal performance with WiFi Sensing, stationary devices such as voice assistants (like Amazon Echo or Google Nest), smart plugs, smart displays, and powered wireless speakers are ideal choices. Wireless clients that are mobile can move around and generally have aggressive sleep modes, less reliable Channel State Information (CSI) data, and are not able to be used to help identify localization, all of which can impact the WiFi Motion performance.

Guardian

Guardian is the name of the application that runs on a device, such as an Access Point, WiFi Extender, or IoT device, within a WiFi Network. It's primary functions are to store configuration settings, communicate with WiFi devices within a network, and communicate with the WiFi Motion infrastructure.

Radar

Radar is the name of the application that runs on every access point within a WiFi Motion network. It provides high-resolution stream of motion intensity that is used by the Guardian application.

Management Actions

Provides the ability to manage the nodes within a WiFi Motion network.

Home Insights

Home Insights is a microservice that provides motion-based activity and sleep insights data.

Operations

Insights (Deprecated)

Provides you with the ability to gain insights into activity and sleep patterns. This has since been replaced by Home Insights.

Motion History

Motion History refers to the motion that was previously detected within a WiFi Motion network.

Operations

Location Data

Provides you the ability to query historical data related to where motion was detected within a WiFi Motion network.

Operations

Network Events

Events are messages that are sent within the WiFi Motion environment, and are often synonymous with notifications or alerts. Some examples of event categories are Device, Link, Motion, Scene, System, and User events.

Operations

Universal Alerts

Operations

Generic

A webhook is an automated message sent from one app to another when a specific event occurs, like a payment or a code commit. It works by sending an HTTP request containing data (a "payload") to a unique URL provided by the receiving application. This allows for real-time data sharing and communication between applications without constant polling.

Live Motion

Live Motion refers to the ability to collect multiple signals in near real-time from within a WiFi Motion network, which can then be used for visualizing movement, identifying where the motion occurred, and more.

Operations

Management

Provides you the ability to monitor management actions in near real-time.