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

Obtain Network Metadata

Request

Security
ApiKey
Path
network_idintegerrequired

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.

Query
keystring

If provided, all operations will be relative to this top-level key.

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/meta?key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Network meta config

Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as Bedroom rather than the mac address of the device that is located in the bedroom.

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
Response
application/json
{
  "dwm": {
    "groupId": 1,
    "systemName": "A0B1234C-DE56-7FAB-C89D-E012F3456789",
    "systemOwner": ""
  },
  "location": {
    "01:2a:b3:45:c6:78": "Basement",
    "01:2a:b3:45:c6:7d": "Living Room",
    "01:a2:3b:4c:d5:67": "Basement",
    "01:a2:3b:4c:de:fa": "Basement",
    "a0:12:3b:4c:56:de": "Upstairs Main Bathroom"
  },
  "neuron_env": "",
  "motion_paused": 0,
  "guardian_env": "local",
  "friendly_name": {
    "01:2a:b3:45:c6:78": "Basement Landing",
    "01:2a:b3:45:c6:7d": "Stereo",
    "01:a2:3b:4c:d5:67": "TV - Backroom",
    "01:a2:3b:4c:de:fa": "TV - Fireplace",
    "a0:12:3b:4c:56:de": "Upstairs Hallway"
  }
}

Set Network metadata

Request

Security
ApiKey
Path
network_idintegerrequired

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.

Query
keystring

If provided, all operations will be relative to this top-level key.

updateboolean

When true the new configuration is immediately propagated to the network.

Default false
Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as Bedroom rather than the mac address of the device that is located in the bedroom.

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/meta?key=string&update=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dwm": {
      "groupId": "string",
      "systemName": "string",
      "systemType": "string",
      "systemOwner": "string",
      "configurationType": "string"
    },
    "home": {
      "sens": 0,
      "cooldown": 0,
      "sensitivity_level": "string"
    },
    "location": {
      "property1": "string",
      "property2": "string"
    },
    "neuron_env": "string",
    "motion_paused": 0,
    "mqSecureRadarPort": 0,
    "auto_segment": 0,
    "guardian_env": "string",
    "friendly_name": {
      "property1": "string",
      "property2": "string"
    },
    "new_network_id": 0,
    "old_network_id": 0,
    "new_guardian_id": "string",
    "gatekeeper_redirect": "string",
    "property1": "string",
    "property2": "string"
  }'

Responses

Network meta config

Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as Bedroom rather than the mac address of the device that is located in the bedroom.

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
Response
application/json
{
  "dwm": {
    "groupId": "string",
    "systemName": "string",
    "systemType": "string",
    "systemOwner": "string",
    "configurationType": "string"
  },
  "home": {
    "sens": 0,
    "cooldown": 0,
    "sensitivity_level": "string"
  },
  "location": {
    "property1": "string",
    "property2": "string"
  },
  "neuron_env": "string",
  "motion_paused": 0,
  "mqSecureRadarPort": 0,
  "auto_segment": 0,
  "guardian_env": "string",
  "friendly_name": {
    "property1": "string",
    "property2": "string"
  },
  "new_network_id": 0,
  "old_network_id": 0,
  "new_guardian_id": "string",
  "gatekeeper_redirect": "string",
  "property1": "string",
  "property2": "string"
}

Update Network Metadata

Request

Security
ApiKey
Path
network_idintegerrequired

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.

Query
keystring

If provided, all operations will be relative to this top-level key.

updateboolean

When true the new configuration is immediately propagated to the network.

Default false
Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as Bedroom rather than the mac address of the device that is located in the bedroom.

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/meta?key=string&update=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dwm": {
      "groupId": "string",
      "systemName": "string",
      "systemType": "string",
      "systemOwner": "string",
      "configurationType": "string"
    },
    "home": {
      "sens": 0,
      "cooldown": 0,
      "sensitivity_level": "string"
    },
    "location": {
      "property1": "string",
      "property2": "string"
    },
    "neuron_env": "string",
    "motion_paused": 0,
    "mqSecureRadarPort": 0,
    "auto_segment": 0,
    "guardian_env": "string",
    "friendly_name": {
      "property1": "string",
      "property2": "string"
    },
    "new_network_id": 0,
    "old_network_id": 0,
    "new_guardian_id": "string",
    "gatekeeper_redirect": "string",
    "property1": "string",
    "property2": "string"
  }'

Responses

Network meta config

Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as Bedroom rather than the mac address of the device that is located in the bedroom.

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
Response
application/json
{
  "dwm": {
    "groupId": "string",
    "systemName": "string",
    "systemType": "string",
    "systemOwner": "string",
    "configurationType": "string"
  },
  "home": {
    "sens": 0,
    "cooldown": 0,
    "sensitivity_level": "string"
  },
  "location": {
    "property1": "string",
    "property2": "string"
  },
  "neuron_env": "string",
  "motion_paused": 0,
  "mqSecureRadarPort": 0,
  "auto_segment": 0,
  "guardian_env": "string",
  "friendly_name": {
    "property1": "string",
    "property2": "string"
  },
  "new_network_id": 0,
  "old_network_id": 0,
  "new_guardian_id": "string",
  "gatekeeper_redirect": "string",
  "property1": "string",
  "property2": "string"
}

Application Settings

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

Operations

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.