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

Network event history

Request

Retrieve a list of events.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

Query
frominteger

To go FORWARD in time, provide the UTC timestamp of the newest report client has received.

tointeger

To go BACK in time, provide the UTC timestamp of the oldest report client has received.

filterstring

Only return a particular category of event: Link, Network, Motion

lastinteger

Maximum number of events to return, default is 10

Default 10
sortboolean

When true the returned events will be post-sorted by timestamp (in case it's possible they were written out of order)

Default false
event_typesstring

Specifies the event parameter used to filter the query results

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/events/history?from=0&to=0&filter=string&last=10&sort=false&event_types=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 - OK

Bodyapplication/jsonArray [
_idstring

Event uuid (for tagging)

categorystringrequired

Event category (for filtering)

Enum"Link""Network""Motion""System"
locArray of objects

Event location

detailobject

Event detail k/v pairs

link_dst_namestring

The friendly name of the link that created the event. This will also be the same identifier that is seen at the beginning of the link_id field.

network_idintegerrequired

Guardian network_id

tsnumber(float)required

UTC timestamp

evt_detected_tsnumber(float)

Present in MotionStoppedEvent. References the UTC timestamp of preceding MotionDetectedEvent.

intensity_windowArray of numbers(float)

Array of float, of length guardian_config.motion_events.density_window -1 (Nominally len 7). Corresponds to the motion intensity values in the integration buffer at the time of the DetectedEvent.

link_idstring

Identifiers of the link that generated a MotionDetectedEvent message in the format of link_dst_name.link_src_name.

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.

tagstring

Event tag. Note that this field is always space-padded to 10 characters.

link_src_namestring

The friendly name of the link that received the event. This will also be the same identifier that is seen at the end of the link_id field.

guardian_idstringrequired

Guardian deviceId

node_idinteger

Database id of this node that generate the event

deviceIdstring

Device identification, such as mac address

node_namestring

Alternative device identification, that can be used by vendor from deviceId

debugobject(MotionStoppedEventDebug)

Motion detection parameters from event generator. Used for debug and sensitivity calibration purposes. Present in MotionStoppedEvent on newer firmware.

armedinteger

Feedback of armed from GuardianConfig.motion_events

If 0, this event will not be stored in history or pushed to the user.

eventstringrequired

Event identifier

Enum"MotionDetectedEvent""MotionStoppedEvent""LinkConnectedEvent""LinkDisconnectedEvent""LinkLowThroughputEvent""LinkCreatedEvent""MemberArrivedEvent""MemberLeftEvent""MemberJoinedEvent""MemberRemovedEvent"
_consumerstring

The consumer for Custom Alerts.

dataobject

Data from Custom Alerts.

]
Response
application/json
[
  {
    "_id": "string",
    "category": "Link",
    "loc": [ … ],
    "detail": { … },
    "link_dst_name": "string",
    "network_id": 0,
    "ts": 0.1,
    "evt_detected_ts": 0.1,
    "intensity_window": [ … ],
    "link_id": "string",
    "loc_name": "string",
    "tag": "string",
    "link_src_name": "string",
    "guardian_id": "string",
    "node_id": 0,
    "deviceId": "string",
    "node_name": "string",
    "debug": { … },
    "armed": 0,
    "event": "MotionDetectedEvent",
    "_consumer": "string",
    "data": { … }
  }
]

Event tagging

Request

Adds a string based tag to an event. Tags greater than 10 characters are truncated.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

Query
eventidstring
tagstring
curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/events/tag?eventid=string&tag=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Event stored OK

Bodyapplication/json
_idstring

Event uuid (for tagging)

categorystringrequired

Event category (for filtering)

Enum"Link""Network""Motion""System"
locArray of objects

Event location

detailobject

Event detail k/v pairs

link_dst_namestring

The friendly name of the link that created the event. This will also be the same identifier that is seen at the beginning of the link_id field.

network_idintegerrequired

Guardian network_id

tsnumber(float)required

UTC timestamp

evt_detected_tsnumber(float)

Present in MotionStoppedEvent. References the UTC timestamp of preceding MotionDetectedEvent.

intensity_windowArray of numbers(float)

Array of float, of length guardian_config.motion_events.density_window -1 (Nominally len 7). Corresponds to the motion intensity values in the integration buffer at the time of the DetectedEvent.

link_idstring

Identifiers of the link that generated a MotionDetectedEvent message in the format of link_dst_name.link_src_name.

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.

tagstring

Event tag. Note that this field is always space-padded to 10 characters.

link_src_namestring

The friendly name of the link that received the event. This will also be the same identifier that is seen at the end of the link_id field.

guardian_idstringrequired

Guardian deviceId

node_idinteger

Database id of this node that generate the event

deviceIdstring

Device identification, such as mac address

node_namestring

Alternative device identification, that can be used by vendor from deviceId

debugobject(MotionStoppedEventDebug)

Motion detection parameters from event generator. Used for debug and sensitivity calibration purposes. Present in MotionStoppedEvent on newer firmware.

armedinteger

Feedback of armed from GuardianConfig.motion_events

If 0, this event will not be stored in history or pushed to the user.

eventstringrequired

Event identifier

Enum"MotionDetectedEvent""MotionStoppedEvent""LinkConnectedEvent""LinkDisconnectedEvent""LinkLowThroughputEvent""LinkCreatedEvent""MemberArrivedEvent""MemberLeftEvent""MemberJoinedEvent""MemberRemovedEvent"
_consumerstring

The consumer for Custom Alerts.

dataobject

Data from Custom Alerts.

Response
application/json
{
  "_id": "string",
  "category": "Link",
  "loc": [
    null
  ],
  "detail": {
    "property1": "string",
    "property2": "string"
  },
  "link_dst_name": "string",
  "network_id": 0,
  "ts": 0.1,
  "evt_detected_ts": 0.1,
  "intensity_window": [
    0.1
  ],
  "link_id": "string",
  "loc_name": "string",
  "tag": "string",
  "link_src_name": "string",
  "guardian_id": "string",
  "node_id": 0,
  "deviceId": "string",
  "node_name": "string",
  "debug": {
    "linkSens": {},
    "msad": [ … ],
    "links": [ … ],
    "mconf": [ … ],
    "sens": 1
  },
  "armed": 0,
  "event": "MotionDetectedEvent",
  "_consumer": "string",
  "data": {
    "title": "string",
    "uuid": "string",
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "sub": "string",
    "user": { … }
  }
}

Event creation

Request

Creates a new event, which must have all fields in the event schema populated. Note that the tag attribute will be ignored if provided. Tags can be applied after the event has been created.

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

Bodyapplication/json
tsnumber(float)required

UTC timestamp

guardian_idstring

Guardian deviceId

network_idintegerrequired

Guardian network_id

categorystringrequired

Event category (for filtering)

Enum"Link""Network""Motion""System""User""Device""Internal"
eventstringrequired

Event identifier

Enum"MotionDetectedEvent""MotionStoppedEvent""LinkConnectedEvent""LinkDisconnectedEvent""LinkLowThroughputEvent""LinkCreatedEvent""MemberArrivedEvent""MemberLeftEvent""MemberJoinedEvent""MemberRemovedEvent"
deviceIdstring

Device identification, such as mac address

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/events/create' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ts": 0.1,
    "guardian_id": "string",
    "network_id": 0,
    "category": "Link",
    "event": "MotionDetectedEvent",
    "deviceId": "string"
  }'

Responses

Event stored OK

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations