Skip to content

Cognitive Systems App Core API

The Core APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. It offers interfaces for accessing topologies, events, motion data, and more.

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

Network Settings

Operations

Motion History

Operations

Live Motion

Operations

Events

Operations

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Find by Meta field

Request

Note: You will have to urlencode the query string here, use the library provided by your runtime.

Example queries where 'val' is a partial string match (use % as wildcard char):

meta->>'guardian_env' (this will match the guardian_env key of the network meta blob)

meta->'dwm'->>'systemName' (this will match the systemName key of the dwm object in the network meta blob)

Example query checking for existence of a field (omit val to directly execute):

meta->'dwm' \\? 'systemName'

Security
ApiKey
Path
querystringrequired

Guardian device ID

Query
valstring

Value to search for

arrayboolean

The default behavior is to return an array when there are multiple results and a single object in the case of a single result. When this parameter is true the response will always be an array.

Default false
expandNodesboolean

If true, will also return an array of all nodes belonging to this network under the 'nodes' key.

Default false
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/find/meta/{query}?val=string&array=false&expandNodes=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/jsonArray [
last_guardian_statusobject or null(GuardianStatusReport)

In a WiFi Motion network, guardian-status messages are transmitted in an approximate 5 minute intervals. Guardian-status messages contain the state information of a WiFi Motion node or network, such as current connected devices, software versions, various metrics, and more.

radar_configobject(RadarConfig)

Configuration that's shared by all Nodes in this Motion Network.

guardian_configobject(GuardianConfig)

Configuration for gateway or mesh root.

created_atnumber(float)required

UTC second timestamp of network creation.

updated_atnumber(float)required

UTC second timestamp of last configuration update.

guardian_idstringrequired

Unique network identifier. Populated by location_id on network creation.

last_heardnumber(float)

UTC timestamp of last guardian-status message.

metaobject(MetaConfig)

Network metadata storage.

master_node_idintegerrequired

Unique ID of gateway or mesh root node.

shard_idintegerrequired

Identifies the shard the network is stored in.

guardian_typestringrequired

String representation of network's shard in shard-shard-id format.

disconnected_atnumber(float)

UTC second timestamp of recorded disconnection.

nodesArray of objects(MotionNetworkRadarNode)

When expandNodes=true or in a configuration update context, the nodes part of this network are returned in this array.

idinteger(int64)required

Unique network integer identifier.

connection_statusboolean or null

Current connection status (null if has never been connected).

connection_reportobject or null(GuardianEvent)
device_infoobject

Mac-address keyed device info for all clients in this network.

]
Response
application/json
[
  {
    "last_guardian_status": { … },
    "radar_config": { … },
    "guardian_config": { … },
    "created_at": 0.1,
    "updated_at": 0.1,
    "guardian_id": "string",
    "last_heard": 0.1,
    "meta": { … },
    "master_node_id": 0,
    "shard_id": 0,
    "guardian_type": "string",
    "disconnected_at": 0.1,
    "nodes": [ … ],
    "id": 0,
    "connection_status": true,
    "connection_report": { … },
    "device_info": { … }
  }
]

Find by Guardian deviceId

Request

Security
ApiKey
Path
guardian_deviceidstringrequired

Guardian device ID

Query
arrayboolean

The default behavior is to return an array when there are multiple results and a single object in the case of a single result. When this parameter is true the response will always be an array.

Default false
expandNodesboolean

If true, will also return an array of all nodes belonging to this network under the 'nodes' key.

Default false
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/find/device/{guardian_deviceid}?array=false&expandNodes=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/jsonArray [
last_guardian_statusobject or null(GuardianStatusReport)

In a WiFi Motion network, guardian-status messages are transmitted in an approximate 5 minute intervals. Guardian-status messages contain the state information of a WiFi Motion node or network, such as current connected devices, software versions, various metrics, and more.

radar_configobject(RadarConfig)

Configuration that's shared by all Nodes in this Motion Network.

guardian_configobject(GuardianConfig)

Configuration for gateway or mesh root.

created_atnumber(float)required

UTC second timestamp of network creation.

updated_atnumber(float)required

UTC second timestamp of last configuration update.

guardian_idstringrequired

Unique network identifier. Populated by location_id on network creation.

last_heardnumber(float)

UTC timestamp of last guardian-status message.

metaobject(MetaConfig)

Network metadata storage.

master_node_idintegerrequired

Unique ID of gateway or mesh root node.

shard_idintegerrequired

Identifies the shard the network is stored in.

guardian_typestringrequired

String representation of network's shard in shard-shard-id format.

disconnected_atnumber(float)

UTC second timestamp of recorded disconnection.

nodesArray of objects(MotionNetworkRadarNode)

When expandNodes=true or in a configuration update context, the nodes part of this network are returned in this array.

idinteger(int64)required

Unique network integer identifier.

connection_statusboolean or null

Current connection status (null if has never been connected).

connection_reportobject or null(GuardianEvent)
device_infoobject

Mac-address keyed device info for all clients in this network.

]
Response
application/json
[
  {
    "last_guardian_status": { … },
    "radar_config": { … },
    "guardian_config": { … },
    "created_at": 0.1,
    "updated_at": 0.1,
    "guardian_id": "string",
    "last_heard": 0.1,
    "meta": { … },
    "master_node_id": 0,
    "shard_id": 0,
    "guardian_type": "string",
    "disconnected_at": 0.1,
    "nodes": [ … ],
    "id": 0,
    "connection_status": true,
    "connection_report": { … },
    "device_info": { … }
  }
]

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations