Cognitive Systems WiFi Motion App-Cloud API (v1-5-x)

App Cloud APIs are used by mobile applications.

Download OpenAPI description
v1-5-x.json
v1-5-x.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/

https://docs.cognitivesystems.com/api/v1/

Overview

Operations

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Show Motion Settings

Request

Query
network_idinteger
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/network_motion_config?network_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
cooldowninteger
Example: 200
sensitivity_levelstring
Enum"very-low""low""normal""high"
Example: "low"
Response
application/json
{
  "cooldown": 200,
  "sensitivity_level": "low"
}

Update Motion Settings

Request

Bodyapplication/json
network_idinteger or numberrequired
Example: 6
Any of:
integer
cooldowninteger or number
Example: 300
Any of:
integer
sensitivity_levelstring
Enum"very-low""low""normal""high"
Example: "normal"
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/network_motion_config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 6,
    "cooldown": 300,
    "sensitivity_level": "normal"
  }'

Responses

Bodyapplication/json
cooldowninteger
Example: 300
sensitivity_levelstring
Enum"very-low""low""normal""high"
Example: "low"
Response
application/json
{
  "cooldown": 300,
  "sensitivity_level": "low"
}

Show Default Locations

Request

Query
network_idinteger
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/default_locations?network_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A unique harded coded list of locations stored by the cloud, however this list expands as new custom locations are assigned to leafs or nodes

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "Kitchen",
  "Bedroom",
  "Living Room",
  "Entrance",
  "Primary Bedroom",
  "Basement"
]

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations