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

Network Topology

Request

Provides the topology of the network.

Security
Authorization
Query
network_idinteger>= 1
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/topologies?network_id=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
tsnumber
devicesArray of objects
linksArray of objects
Response
application/json
{
  "ts": 1606330236.585,
  "devices": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "links": [
    { … },
    { … },
    { … }
  ]
}

Hourly Motion Histograms

Request

Returns historical motion intensities for a given period of time. Intensities are actual motion values stored at two different resolutions (bucket sizes):

  • 1s intervals for the last 24 hours.
  • 5s intervals for the last week. 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.

Security
Authorization
Query
network_idinteger>= 1

Derived from the active session (if the user has rights to this network)

fromnumber

UTC Timestamp

tonumberrequired

UTC Timestamp

bucketinteger[ 1 .. 900 ]

Bucket size in seconds

lastinteger[ 0 .. 400 ]
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/motion_history_intensities?network_id=1&from=0&to=0&bucket=1&last=400' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [Array [
number or null
]]
Response
application/json
[
  [
    0,
    1603299600
  ],
  [
    0,
    1603303200
  ],
  [
    0,
    1603306800
  ],
  [
    0,
    1603310400
  ],
  [
    0,
    1603314000
  ],
  [
    0,
    1603317600
  ],
  [
    0,
    1603321200
  ],
  [
    0,
    1603324800
  ],
  [
    0,
    1603328400
  ],
  [
    0,
    1603332000
  ],
  [
    0,
    1603335600
  ],
  [
    0,
    1603339200
  ],
  [
    2.68,
    1603342800
  ],
  [
    3.04,
    1603346400
  ],
  [
    0,
    1603350000
  ],
  [
    0,
    1603353600
  ],
  [
    0,
    1603357200
  ],
  [
    0,
    1603360800
  ],
  [
    0,
    1603364400
  ],
  [
    0,
    1603368000
  ],
  [
    0,
    1603371600
  ],
  [
    0,
    1603375200
  ],
  [
    1.22,
    1603378800
  ],
  [
    2.85,
    1603382400
  ],
  [
    3.02,
    1603386000
  ],
  [
    0,
    1603389600
  ],
  [
    0,
    1603393200
  ],
  [
    0,
    1603396800
  ],
  [
    0,
    1603400400
  ],
  [
    0,
    1603404000
  ],
  [
    0,
    1603407600
  ],
  [
    0,
    1603411200
  ],
  [
    0,
    1603414800
  ],
  [
    0,
    1603418400
  ],
  [
    2.81,
    1603422000
  ],
  [
    1.75,
    1603425600
  ],
  [
    2.93,
    1603429200
  ],
  [
    0,
    1603432800
  ],
  [
    0,
    1603436400
  ],
  [
    0,
    1603440000
  ],
  [
    0,
    1603443600
  ],
  [
    0,
    1603447200
  ],
  [
    0,
    1603450800
  ],
  [
    0,
    1603454400
  ],
  [
    2.65,
    1603458000
  ],
  [
    1.6,
    1603461600
  ],
  [
    3.2,
    1603465200
  ],
  [
    1.98,
    1603468800
  ],
  [
    0,
    1603472400
  ],
  [
    0,
    1603476000
  ],
  [
    0,
    1603479600
  ],
  [
    0,
    1603483200
  ],
  [
    0,
    1603486800
  ],
  [
    0,
    1603490400
  ],
  [
    0,
    1603494000
  ],
  [
    0,
    1603497600
  ],
  [
    0,
    1603501200
  ],
  [
    3.28,
    1603504800
  ],
  [
    2.43,
    1603508400
  ],
  [
    3.74,
    1603512000
  ],
  [
    2.92,
    1603515600
  ],
  [
    0.1,
    1603519200
  ],
  [
    0.21,
    1603522800
  ],
  [
    0.15,
    1603526400
  ],
  [
    0.02,
    1603530000
  ],
  [
    0.14,
    1603533600
  ],
  [
    0.12,
    1603537200
  ],
  [
    3.18,
    1603540800
  ],
  [
    2.88,
    1603544400
  ],
  [
    0.15,
    1603548000
  ],
  [
    1.55,
    1603551600
  ],
  [
    2.89,
    1603555200
  ],
  [
    2.77,
    1603558800
  ],
  [
    3.73,
    1603562400
  ],
  [
    0,
    1603566000
  ],
  [
    1.16,
    1603569600
  ],
  [
    2.2,
    1603573200
  ],
  [
    1.71,
    1603576800
  ],
  [
    0.8,
    1603580400
  ],
  [
    1.58,
    1603584000
  ],
  [
    1.87,
    1603587600
  ],
  [
    3.07,
    1603591200
  ],
  [
    2.91,
    1603594800
  ],
  [
    1.6,
    1603598400
  ],
  [
    1.8,
    1603602000
  ],
  [
    0.14,
    1603605600
  ],
  [
    0.02,
    1603609200
  ],
  [
    0.05,
    1603612800
  ],
  [
    0.12,
    1603616400
  ],
  [
    0.17,
    1603620000
  ],
  [
    0.05,
    1603623600
  ],
  [
    2.97,
    1603627200
  ],
  [
    1.27,
    1603630800
  ],
  [
    0.36,
    1603634400
  ],
  [
    0,
    1603638000
  ],
  [
    3.15,
    1603641600
  ],
  [
    3.24,
    1603645200
  ],
  [
    4.61,
    1603648800
  ],
  [
    3.32,
    1603652400
  ],
  [
    2.6,
    1603656000
  ],
  [
    1.9,
    1603659600
  ],
  [
    3.62,
    1603663200
  ],
  [
    2.51,
    1603666800
  ],
  [
    0.28,
    1603670400
  ],
  [
    1.9,
    1603674000
  ],
  [
    2.61,
    1603677600
  ],
  [
    3.74,
    1603681200
  ],
  [
    2.85,
    1603684800
  ],
  [
    1.11,
    1603688400
  ],
  [
    0.03,
    1603692000
  ],
  [
    0.08,
    1603695600
  ],
  [
    3.59,
    1603699200
  ],
  [
    0.02,
    1603702800
  ],
  [
    0.03,
    1603706400
  ],
  [
    0,
    1603710000
  ],
  [
    0,
    1603713600
  ],
  [
    0.03,
    1603717200
  ],
  [
    2.93,
    1603720800
  ],
  [
    3.59,
    1603724400
  ],
  [
    0,
    1603728000
  ],
  [
    0,
    1603731600
  ],
  [
    0,
    1603735200
  ],
  [
    0,
    1603738800
  ],
  [
    0,
    1603742400
  ],
  [
    0,
    1603746000
  ],
  [
    0,
    1603749600
  ],
  [
    3.45,
    1603753200
  ],
  [
    0.37,
    1603756800
  ],
  [
    3.2,
    1603760400
  ],
  [
    0.05,
    1603764000
  ],
  [
    0.17,
    1603767600
  ],
  [
    5.18,
    1603771200
  ],
  [
    5.85,
    1603774800
  ],
  [
    3.13,
    1603778400
  ],
  [
    3.95,
    1603782000
  ],
  [
    3.53,
    1603785600
  ],
  [
    0,
    1603789200
  ],
  [
    2.88,
    1603792800
  ],
  [
    0,
    1603796400
  ],
  [
    0.02,
    1603800000
  ],
  [
    3.67,
    1603803600
  ],
  [
    4.08,
    1603807200
  ],
  [
    3.46,
    1603810800
  ],
  [
    0,
    1603814400
  ],
  [
    0,
    1603818000
  ],
  [
    0,
    1603821600
  ],
  [
    0,
    1603825200
  ],
  [
    0,
    1603828800
  ],
  [
    0,
    1603832400
  ],
  [
    0,
    1603836000
  ],
  [
    0,
    1603839600
  ],
  [
    0,
    1603843200
  ],
  [
    2.65,
    1603846800
  ],
  [
    3.72,
    1603850400
  ],
  [
    7.08,
    1603854000
  ],
  [
    1.74,
    1603857600
  ],
  [
    0.53,
    1603861200
  ],
  [
    2.13,
    1603864800
  ],
  [
    0.2,
    1603868400
  ],
  [
    3.01,
    1603872000
  ],
  [
    0.28,
    1603875600
  ],
  [
    0.31,
    1603879200
  ],
  [
    0.33,
    1603882800
  ],
  [
    0.35,
    1603886400
  ],
  [
    0.23,
    1603890000
  ],
  [
    0.29,
    1603893600
  ],
  [
    3.48,
    1603897200
  ],
  [
    3.91,
    1603900800
  ],
  [
    3.02,
    1603904400
  ]
]

Live Motion Websocket

Request

Open a Websocket connection streaming live motion data.

Security
Authorization
Query
tokenstring[a-zA-Z0-9\-_]+?\.[a-zA-Z0-9\-_]+?\.([a-zA-Z0...required

The JWT token.

network_idnumber> 7required

The internal network ID

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/motions?token=string&network_id=8' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Streaming motion data.

Bodyapplication/json
tsnumber

UTC epoch timestamp

Example: 1660309417.96
linksArray of strings

Array of source-destination device names.

Example: ["4C72900A72.EM7F6001D5","EM7F6001D5.0c80639418d0","EM7F6001D5.4C72900A72","EM7F6001D5.64166679e0cb"]
dataobject

Raw motion data

Example: {"lraw":[0.04,0,0.15,0.03],"mkai":[0.04,0,0.15,0],"mkai_original":[0.04,0,0.15,0],"mkai_scaled":[0.04,0,0.15,0],"throughput":[1,1,1,1]}
locArray of strings

Localization result or 'nomotion'.

Example: ["4C72900A72"]
intervalinteger

500 ms message interval

Example: 500
countinteger

Always 1.

Example: 1
last_motionnumber

UTC opch timestamp of last motion.

Example: 1660308050.97
loc_namestring

The loc_name field provides a description based the information available as to where motion was likely to have occurred within the network.

Example: "4C72900A72"
Response
application/json
{
  "ts": 1660309417.96,
  "links": [
    "4C72900A72.EM7F6001D5",
    "EM7F6001D5.0c80639418d0",
    "EM7F6001D5.4C72900A72",
    "EM7F6001D5.64166679e0cb"
  ],
  "data": {
    "lraw": [ … ],
    "mkai": [ … ],
    "mkai_original": [ … ],
    "mkai_scaled": [ … ],
    "throughput": [ … ]
  },
  "loc": [
    "4C72900A72"
  ],
  "interval": 500,
  "count": 1,
  "last_motion": 1660308050.97,
  "loc_name": "4C72900A72"
}

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations