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

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Sensor Integration is the process where a standalone sensor (like a Motion Tag or Bath Sensor) establishes a secure communication link with the WiFi Motion Plug network.

Operations

Delete Sensor or Hub

Request

Removes a sensor or hub. Deleting a Hub also includes the removal and deletion of associated child sensors. This deletion propagates to the Third Reality Cloud and will dispatch DeviceRemoved events for each sensor which will remove the sensors from App Cloud's Devices list. Sensors that are deleted need to be re-paired by being placed into pairing mode using the physical reset button. Removed Hubs will need to also be physically reset and provided userThingName and WiFi ssid / password via Bluetooth.

Path
THING_NAMEstringrequired

Sensor or Hub thingName.

curl -i -X DELETE \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/devices/{THING_NAME}'

Responses

204 No Content

Obtain Detections for All Sensors

Request

Generic API to query sensor detections for the network without any filters or selected time ranges.

Query
frominteger>= 0

Greater than or equal to the oldest time of a sensor detection.

tointeger>= 0

Great than or equal to the newest time of a sensor detection.

latestboolean

The latest sensor detection. The sensor with the most recent detection will be provided.

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/history?from=0&to=0&latest=true'

Responses

200 OK

Bodyapplication/json
network_idstring
sensor_detectionsArray of objects
Response
application/json
{
  "network_id": "1",
  "sensor_detections": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Obtain detections for a single Sensor

Request

Generic API to query sensor detections by thingName without any filters or selected time ranges.

Path
THING_NAMEstringrequired

Sensor thingName.

Query
frominteger>= 0

Greater than or equal to the oldest time of a sensor detection.

tointeger>= 0

Great than or equal to the newest time of a sensor detection.

latestboolean

The latest sensor detection. If specifying a specific sensor, then the latest sensor detection for that sensor will be provided. If querying all sensors, then the sensor with the most recent detection will be provided.

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/history/{THING_NAME}?from=0&to=0&latest=true'

Responses

200 OK

Bodyapplication/json
network_idstring
sensor_detectionsArray of objects
Response
application/json
{
  "network_id": "1",
  "sensor_detections": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}