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

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations

Global Search

Request

Path
search_keystringrequired

Email, first-name, or last-name

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/internal/search/{search_key}'

Responses

Bodyapplication/jsonArray [
first_namestring
last_namestring
emailstring
network_idinteger
network_namestring
user_countinteger
external_idinteger
token_timestampsArray of objects
online_statusboolean
]
Response
application/json
[
  {
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@gmail.com",
    "network_id": 185,
    "network_name": "3e362f",
    "user_count": 2,
    "external_id": 156,
    "token_timestamps": [],
    "online_status": true
  }
]

Search Users

Request

Retrieves array of all users that have similar firstname or lastname.

Path
namestringrequired
Query
ownerbooleanrequired
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/internal/users/search/{name}?owner=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
user_idinteger
emailstring
first_namestring
last_namestring
external_idinteger
network_idinteger
rolestring
]
Response
application/json
[
  {
    "user_id": 3,
    "email": "cogcodeqa@mail.com",
    "first_name": "Dhruvin",
    "last_name": "V",
    "external_id": 156,
    "network_id": 3,
    "role": "owner"
  }
]

All Cached Networks

Request

This endpoint returns all network model stored in the app-cloud. Network models are stored in cache which can be made on-demand by setting ensure field to true. Default radius is 5km, if latitude and longitude is supplied with the request. Haversine Distance is used as distance metric to find networks.

Query
ensureboolean
radiusinteger
latitudenumber
longitudenumber
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/internal/network_map?ensure=true&latitude=0&longitude=0&radius=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger
namestring
created_atstring
updated_atstring
external_idinteger
user_countinteger
latitudestring
longitudestring
addressstring
timezonestring
pet_sizestring
building_typestring
building_sizestring
live_enabledboolean
scene_idinteger
Response
application/json
{
  "id": 0,
  "name": "string",
  "created_at": "string",
  "updated_at": "string",
  "external_id": 0,
  "user_count": 0,
  "latitude": "string",
  "longitude": "string",
  "address": "string",
  "timezone": "string",
  "pet_size": "string",
  "building_type": "string",
  "building_size": "string",
  "live_enabled": true,
  "scene_id": 0
}