Skip to content

Cognitive Systems App Cloud API

The App Cloud APIs expose the Core API endpoints, but with the addition of adding per user authentication and authorization. For example, you may choose to build with App Cloud APIs when developing for a mobile platform.

Download OpenAPI description
app_cloud.json
app_cloud.yaml
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud
https://docs.cognitivesystems.com/api/v1

Overview

Operations

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Sounding v2

Operations

Get Client State

Request

This endpoint allows client-level sounding control and feedback.

Security
Authorization
curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sounding/clients \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
devicesArray of objects(SoundingClientDeviceStatus)
Response
application/json
{
  "devices": [
    { … },
    { … }
  ]
}

Set Client Config

Request

This endpoint allows client-level sounding control and feedback.

Security
Authorization
Query
updateboolean

Default: false When true the new configuration is immediately propagated to the network this node is part of.

If this value is false, the change will be propagated to edge either when the device is rebooted or an update is triggered.

Bodyapplication/json
devicesArray of objects(SoundingClientDeviceConfig)required
Example: [{"id":0,"location":"LocationA"},{"mac":"00:11:22:33:44:55","sensitivity":1,"sounding_mode":"allow"}]
devices[].​macstring

The Mac address of the target device.

Example: "22:33:44:ff:ee:dd"
devices[].​device_idstring

Contains the Serial number, Node Id, or Device ID.

devices[].​idstring

Internal node_id or device_id of the target node.

devices[].​friendly_namestring

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.

Example: "name"
devices[].​locationstring

Device location name assigned to the Device or Node. Maximum of 256 characters, supporting letters, spaces, digits, with only the following special characters: =, +, -, _, @, !. Supports base64 encoding. Can also be an empty string.

Example: "location"
devices[].​sensitivity_modestring

Indicates whether the device is using the global sensitivity setting or is being overridden at the device level.

Enum"override""global"
devices[].​sensitivitynumber

Below is a chart that provides a description of the different Sensitivity Levels that are available:

Sensitivity Level Description Numerical Representation
HighMotion levels of all sizes will trigger detection. Provides optimal coverage for most single family / detached dwellings.1
MediumMotion levels that are moderate or greater will trigger detection. Provides optimal coverage for most dwellings that share one or more walls with a neighbor.2
LowOnly motion levels that are large to intense will trigger detection. Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting.3
Very LowOnly motion levels that are large to intense will trigger detection. This setting is typically only used in scenarios such as a small accommodation with shared walls. Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting.7
devices[].​sounding_modestring

Controls if the device can be used for sounding.

Enum"allow""deny"
Example: "allow"
devices[].​sounding_meshstring

Applicable only to nodes. Controls if the node will accept or reject sounding on mesh links.

Enum"allow""deny"
curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sounding/clients?update=true' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "devices": [
      {
        "id": 0,
        "location": "LocationA"
      },
      {
        "mac": "00:11:22:33:44:55",
        "sensitivity": 1,
        "sounding_mode": "allow"
      }
    ]
  }'

Responses

Bodyapplication/json
statusinteger

0 failure

1 full success

2 some changes failed

3 an IoT update was requested but network has not yet started up

successinteger

1 if the operation was successful, 0 otherwise

detailsobject(WarningErrors)

The list of warnings or errors that occurred during processing of this request.

Response
application/json
{
  "status": 0,
  "success": 0,
  "details": {
    "warnings": [],
    "errors": []
  }
}

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations