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

Update Node Settings

Request

Bodyapplication/json
friendly_namestring
locationstring
network_idintegerrequired
node_idintegerrequired
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/node \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "friendly_name": "string",
    "location": "string",
    "network_id": 0,
    "node_id": 0
  }'

Responses

OK

Show General Settings (With ID)

Request

  • The network_scene_configs field in the res json defaults to an int which represents the row_id of the scene config in postgres.
  • To retrieve the full scene config for the network, use the expand param with a single array item of network_scene_config
Path
idintegerrequired
Query
expandArray of strings
Items Value"network_scene_config"
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/networks/{id}?expand=network_scene_config' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger
Example: "http://json-schema.org/schema#"
addressstring
building_sizestring
building_typestring
latitudestring
longitudestring
live_enabledboolean
name(string or null)
Any of:
string or null
pet_sizestring
timezonestring
user_countnumber
created_atstring
updated_atstring
external_idinteger
scene_idinteger
present_countinteger
claimedboolean
owner_emailstring
network_scene_config(object or null) or (integer or null)
Any of:
object or null
subscription_idstring or null
Response
application/json
{
  "id": "http://json-schema.org/schema#"
}

Update General Settings

Request

  • Updates App Cloud network with user-specific information. User must have the role "owner" for the corresponding network.
  • Request body does not require all listed fields, but fields must match type and value validations

To update the timezone, only pass timezone in the request body:

{ "timezone": "Europe/Warsaw" }

Path
idintegerrequired
Query
expandArray of strings
Bodyapplication/json
namestring
addressstring
latitudeinteger
longitudeinteger
timezonestring
pet_sizestring
scene_idinteger
building_typestring
building_sizestring
live_enabledboolean
idinteger
curl -i -X PUT \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/networks/{id}?expand=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "address": "string",
    "latitude": 0,
    "longitude": 0,
    "timezone": "string",
    "pet_size": "string",
    "scene_id": 0,
    "building_type": "string",
    "building_size": "string",
    "live_enabled": true,
    "id": 0
  }'

Responses

Bodyapplication/json
idinteger
addressstring
building_sizestring
building_typestring
latitudestring
longitudestring
live_enabledboolean
name(string or null)
Any of:
string or null
pet_sizestring
timezonestring
user_countnumber
created_atstring
updated_atstring
external_idinteger
scene_idinteger
present_countinteger
claimedboolean
network_scene_config(object or null) or (integer or null)
Any of:
object or null
owner_emailstring
subscription_idstring or null
Response
application/json
{
  "id": 0,
  "address": "string",
  "building_size": "string",
  "building_type": "string",
  "latitude": "string",
  "longitude": "string",
  "live_enabled": true,
  "name": "string",
  "pet_size": "string",
  "timezone": "string",
  "user_count": 0,
  "created_at": "string",
  "updated_at": "string",
  "external_id": 0,
  "scene_id": 0,
  "present_count": 0,
  "claimed": true,
  "network_scene_config": {},
  "owner_email": "string",
  "subscription_id": "string"
}

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations