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

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

Config

Operations

Get Guardian configuration

Request

Security

ApiKey

Path

network_idintegerrequired

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

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}/config/guardian?key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

history_motionobject

device_eventsobject

live_motionobject

link_eventsobject

leafblowerobject

debugobject

user_priorityArray of strings

The list of user priority rooms in order from highest to lowest

motion_eventsobject

Response

application/json

{
  "history_motion": {
    "count": 60,
    "enable": 1,
    "interval": 5000,
    "flush_interval": 300
  },
  "device_events": {
    "enable": 0
  },
  "live_motion": {
    "enable": 1,
    "force_enable": 0,
    "interval": 500,
    "loc_conf_enable": 0
  },
  "link_events": {
    "enable": 0,
    "throughput_threshold": 0,
    "idle_link_timeout": 0,
    "throughput_cooldown": 0,
    "noise_duration": 0,
    "noise_cooldown": 0,
    "noise_threshold": 0,
    "throughput_duration": 0
  },
  "leafblower": {
    "cutoff": 0,
    "blower_size": 60,
    "log_debug": 0,
    "link_expiry": 1008,
    "sneaky_cutoff": -1.1,
    "sneaky_link_limit": 0,
    "whitelist": { … },
    "link_limit": 3,
    "whitelist_enable": 0,
    "cycle_count": 10,
    "cycle_time": 0
  },
  "debug": {
    "status": 0,
    "leafblower": 0,
    "gateway": 0,
    "zilker": 0
  },
  "user_priority": [
    "string"
  ],
  "motion_events": {
    "enable": 1,
    "threshold": 0,
    "pet_mode": 0,
    "cooldown": 0,
    "excessive_mins": 0,
    "excessive_density": 0.7,
    "pulse_enabled": 0,
    "pulse_interval": 0,
    "armed": 1,
    "override": { … },
    "property1": 0,
    "property2": 0
  }
}

Set Guardian configuration

Request

Security

ApiKey

Path

network_idintegerrequired

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

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

history_motionobject

device_eventsobject

live_motionobject

link_eventsobject

leafblowerobject

debugobject

user_priorityArray of strings

The list of user priority rooms in order from highest to lowest

motion_eventsobject

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/config/guardian?key=string&update=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "history_motion": {
      "count": 60,
      "enable": 1,
      "interval": 5000,
      "flush_interval": 300
    },
    "device_events": {
      "enable": 0
    },
    "live_motion": {
      "enable": 1,
      "force_enable": 0,
      "interval": 500,
      "loc_conf_enable": 0
    },
    "link_events": {
      "enable": 0,
      "throughput_threshold": 0,
      "idle_link_timeout": 0,
      "throughput_cooldown": 0,
      "noise_duration": 0,
      "noise_cooldown": 0,
      "noise_threshold": 0,
      "throughput_duration": 0
    },
    "leafblower": {
      "cutoff": 0,
      "blower_size": 60,
      "log_debug": 0,
      "link_expiry": 1008,
      "sneaky_cutoff": -1.1,
      "sneaky_link_limit": 0,
      "whitelist": {
        "property1": 0,
        "property2": 0
      },
      "link_limit": 3,
      "whitelist_enable": 0,
      "cycle_count": 10,
      "cycle_time": 0
    },
    "debug": {
      "status": 0,
      "leafblower": 0,
      "gateway": 0,
      "zilker": 0
    },
    "user_priority": [
      "string"
    ],
    "motion_events": {
      "enable": 1,
      "threshold": 0,
      "pet_mode": 0,
      "cooldown": 0,
      "excessive_mins": 0,
      "excessive_density": 0.7,
      "pulse_enabled": 0,
      "pulse_interval": 0,
      "armed": 1,
      "override": {
        "min_duration": 0,
        "density_window": 0,
        "density_thres": 0,
        "intensity_thres": 0
      },
      "property1": 0,
      "property2": 0
    }
  }'

Responses

OK.

Bodyapplication/json

history_motionobject

device_eventsobject

live_motionobject

link_eventsobject

leafblowerobject

debugobject

user_priorityArray of strings

The list of user priority rooms in order from highest to lowest

motion_eventsobject

Response

application/json

{
  "history_motion": {
    "count": 60,
    "enable": 1,
    "interval": 5000,
    "flush_interval": 300
  },
  "device_events": {
    "enable": 0
  },
  "live_motion": {
    "enable": 1,
    "force_enable": 0,
    "interval": 500,
    "loc_conf_enable": 0
  },
  "link_events": {
    "enable": 0,
    "throughput_threshold": 0,
    "idle_link_timeout": 0,
    "throughput_cooldown": 0,
    "noise_duration": 0,
    "noise_cooldown": 0,
    "noise_threshold": 0,
    "throughput_duration": 0
  },
  "leafblower": {
    "cutoff": 0,
    "blower_size": 60,
    "log_debug": 0,
    "link_expiry": 1008,
    "sneaky_cutoff": -1.1,
    "sneaky_link_limit": 0,
    "whitelist": { … },
    "link_limit": 3,
    "whitelist_enable": 0,
    "cycle_count": 10,
    "cycle_time": 0
  },
  "debug": {
    "status": 0,
    "leafblower": 0,
    "gateway": 0,
    "zilker": 0
  },
  "user_priority": [
    "string"
  ],
  "motion_events": {
    "enable": 1,
    "threshold": 0,
    "pet_mode": 0,
    "cooldown": 0,
    "excessive_mins": 0,
    "excessive_density": 0.7,
    "pulse_enabled": 0,
    "pulse_interval": 0,
    "armed": 1,
    "override": { … },
    "property1": 0,
    "property2": 0
  }
}

Update Guardian configuration

Request

Security

ApiKey

Path

network_idintegerrequired

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

Query

keystring

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

updateboolean

When true a configuration update is sent to the network immediately.

curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/config/guardian?key=string&update=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

history_motionobject

device_eventsobject

live_motionobject

link_eventsobject

leafblowerobject

debugobject

user_priorityArray of strings

The list of user priority rooms in order from highest to lowest

motion_eventsobject

Response

application/json

{
  "history_motion": {
    "count": 60,
    "enable": 1,
    "interval": 5000,
    "flush_interval": 300
  },
  "device_events": {
    "enable": 0
  },
  "live_motion": {
    "enable": 1,
    "force_enable": 0,
    "interval": 500,
    "loc_conf_enable": 0
  },
  "link_events": {
    "enable": 0,
    "throughput_threshold": 0,
    "idle_link_timeout": 0,
    "throughput_cooldown": 0,
    "noise_duration": 0,
    "noise_cooldown": 0,
    "noise_threshold": 0,
    "throughput_duration": 0
  },
  "leafblower": {
    "cutoff": 0,
    "blower_size": 60,
    "log_debug": 0,
    "link_expiry": 1008,
    "sneaky_cutoff": -1.1,
    "sneaky_link_limit": 0,
    "whitelist": { … },
    "link_limit": 3,
    "whitelist_enable": 0,
    "cycle_count": 10,
    "cycle_time": 0
  },
  "debug": {
    "status": 0,
    "leafblower": 0,
    "gateway": 0,
    "zilker": 0
  },
  "user_priority": [
    "string"
  ],
  "motion_events": {
    "enable": 1,
    "threshold": 0,
    "pet_mode": 0,
    "cooldown": 0,
    "excessive_mins": 0,
    "excessive_density": 0.7,
    "pulse_enabled": 0,
    "pulse_interval": 0,
    "armed": 1,
    "override": { … },
    "property1": 0,
    "property2": 0
  }
}

Node

Operations

Management

Operations

Cognitive Systems App Core API

Network Settings

Motion History

Live Motion

Events

Insights v2

Universal Alerting

Network Status

Network Meta

Location Data

Find

Application Settings

Config

Get Guardian configuration

Request

Responses

Was this helpful?

Set Guardian configuration

Request

Responses

Was this helpful?

Update Guardian configuration

Request

Responses

Was this helpful?

Node

Management

Cognitive Systems App Core API

Network Settings

Motion History

Live Motion

Events

Insights v2

Universal Alerting

Network Status

Network Meta

Location Data

Find

Application Settings

Config

Get Guardian configuration

Request

Responses

Was this helpful?

Set Guardian configuration

RequestExpand all

Responses

Was this helpful?

Update Guardian configuration

Request

Responses

Was this helpful?

Node

Management

Request