Skip to content

Cognitive Systems App Core API

The WiFi Motion Core 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
core.json
core.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/api/core/

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

Find

Operations

Application Settings

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 identifier of the WiFi Motionâ„¢ network.

timezonestring

Timezone configuration

Supported Time Zones
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_detection_enabledboolean

Switch home/away based on door sensor

Default true
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 15
presence_home_window_secondsinteger

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

Default 300
cia_enabledboolean

Are critical inactivity alerts enabled

Default true
cia_escalation_stepinteger

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

Default 0
cia_escalation_threshold_secondsinteger

Time between steps

Default 3600
cia_wake_time_plus_secondsinteger

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

Default 3600
cia_sleep_time_minus_secondsinteger

How long to wait before sleep_time to watch for Critical 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 identifier of the WiFi Motionâ„¢ network.

timezonestring(timezone)

Timezone configuration

Supported Time Zones
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.

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 identifier of the WiFi Motionâ„¢ network.

timezonestring(timezone)

Timezone configuration

Supported Time Zones
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"
  }
}

Config

Operations

Node

Operations

Management

Operations