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

Sounding v2

Operations

Events, History, and Visualizations

Operations

Tag Motion Detected Event

Request

Bodyapplication/json
network_idintegerrequired
Example: 1
eventidstringrequired
Example: "abc123"
tagstring

Must be one of "Human", "Pet" or "False"

Example: "False"
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/event_tag \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 1,
    "eventid": "abc123",
    "tag": "False"
  }'

Responses

Bodyapplication/json
idstring
guardian_idstring
network_idinteger or string
Any of:
integer
timestampnumber
event_typestring
event_categorystring
link_idstring
icon_urlstring
textstring
tagstring
dataobject
Response
application/json
{
  "id": "string",
  "guardian_id": "string",
  "network_id": 0,
  "timestamp": 0,
  "event_type": "string",
  "event_category": "string",
  "link_id": "string",
  "icon_url": "string",
  "text": "string",
  "tag": "string",
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Motion History Densities

Request

Returns historical motion densities for a given period of time. Densities are percentages representing how many samples within a bucket-size had motion values greater than zero.

For example, if the bucket size was 60 seconds, and 11 of the 12 possible 5s buckets had motion then a value of 91.6 would be returned.

It should be noted that data is stored in two resolutions:

1s intervals for the last 24 hours. 5s intervals for the last week. Which means that densities computed on data within the last 24 hours may be retrieved with this request at sub 5s bucket sizes.

This request may return data at a coarser resolution than the requested bucket size, if data at that resolution is not available.

Timestamp ranges are limited by Halo Home to only include times over which the network was last claimed.

Query
network_idnumber>= 1required

Internal App Cloud Id

fromnumber

UTC Timestamp

tonumberrequired

UTC Timestamp

bucketnumber[ 1 .. 900 ]

Bucket size in seconds

lastnumber[ 0 .. 400 ]
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/motion_history_densities?bucket=1&from=0&last=400&network_id=1&to=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [Array [
number or null
]]
Response
application/json
[
  [
    0.02777777777777778,
    1591686000
  ],
  [
    0,
    1591686900
  ],
  [
    0.016666666666666666,
    1591687800
  ]
]

Last Motion Detected Timestamp

Request

Query
network_idinteger>= 1

Network ID is derived from the active session.

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

Responses

Bodyapplication/json
last_motionnumber
Any of:
number
motion_trippednumber
Response
application/json
{
  "last_motion": 0,
  "motion_tripped": 0
}

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations