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

Retrieve Universal Alert rules

Request

Returns an array of all universal alert rules associated with the network.

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/universal-alert \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 - OK

Bodyapplication/json
alertsArray of objects
Example: [{"uuid":"16cd9560-0f13-4ffe-b9b4-127bd0bfaf1d","enabled":false,"alert_name":"Preset Rise and Shine","external_id":14,"rrule":"DTSTART;TZID=Europe/London:20220101T100000\r\nRRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU\r\n","monitor":{"monitor_mode":"SIMPLE","duration_minutes":240,"repeat_monitoring":true},"meta":{"alert_type":"RISE_AND_SHINE_PRESET"},"analytics_tag":"riseAndShinePreset","no_motion_actions":[{"action":"fcm_push","payload":{},"user_ids":[]}],"motion_actions":[{"action":"fcm_push","payload":{},"user_ids":[]}],"unknown_actions":[],"error_actions":[],"timezone":"Europe/London","target":"3/3/2022, 10:00:00 AM - Europe/London","window_end":1646301600000,"window_start":1645301600000,"id":"10"}]
Response
application/json
{
  "alerts": [
    { … }
  ]
}

Create a single custom rule

Request

Creates a single custom Wifi Motion Alert.

Bodyapplication/jsonrequired
enabledboolean
alert_namestring

Defaults to an empty string if no value is provided.

Default ""
rrulestring

The RRULE string which can be generated here: https://jakubroztocil.github.io/rrule/

Note that new lines must be explicitly escaped with \n. Note that providing the RRULE string without the RRULE will result in a yearly alert. For a single occurrence, COUNT=1 must be provided

Example: DTSTART;TZID=America/New_York:20211201T163000\nRRULE:FREQ=WEEKLY;COUNT=30;INTERVAL=1;WKST=MO

Default ""
monitorobjectrequired

Motion monitor object. monitor_mode Specifies the type of monitoring.

NONE: Ignore motion and triggers actions at specified time.

SIMPLE: Checks period between alert trigger and duration_minutes.

INACTIVITY: checks for inactivity in the given period. inactive_minutes specifies the length of the inactivity. repeat_monitoring specifies if the alert should continue after inactivity was detected

monitor.​monitor_modestring
Enum"NONE""SIMPLE""INACTIVITY"
monitor.​duration_minutesinteger

The length of time in minutes of the monitored duration. The cloud will determine the start time per the timezone in the rrule field by subtracting this from the targeted time of the monitor completion (in which the result is sent).

monitor.​inactive_minutesinteger

Required if the monitor_mode is "INACTIVITY"

monitor.​repeat_monitoringboolean

If the monitor_mode is "INACTIVITY", this boolean determines if the alert should continue monitoring if inactivity is detected. Defaults to true

monitor.​stop_event_filterobject

Not yet supported - 1/1/2022

The keys of the object will compare to keys of MQTT events as they are from core. All key value pairs placed in this object will be expected on the event from core.

Default {}
metaobject

The contents of this object are decided by the client and will not persist if the alert is deleted.

analytics_tagstring

Any string that can be used for analytics tracing. Defaults to "" if the field is not included.

Default ""
no_motion_actionsArray of objects(Root Type for POST_universal_alerts_actions)

Actions to perform when no motion is detected

motion_actionsArray of objects(Root Type for POST_universal_alerts_actions)

Actions to perform when motion is detected

unknown_actionsArray of objects(Root Type for POST_universal_alerts_actions)

Actions to perform when there is no record of past motion on the network

error_actionsArray of objects(Root Type for POST_universal_alerts_actions)

Actions to perform when an error occurs

curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/universal-alert \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "alert_name": "",
    "rrule": "",
    "monitor": {
      "monitor_mode": "NONE",
      "duration_minutes": 0,
      "inactive_minutes": 0,
      "repeat_monitoring": true,
      "stop_event_filter": {}
    },
    "meta": {},
    "analytics_tag": "",
    "no_motion_actions": [
      {
        "action": "string",
        "user_ids": [
          0
        ],
        "payload": {}
      }
    ],
    "motion_actions": [
      {
        "action": "string",
        "user_ids": [
          0
        ],
        "payload": {}
      }
    ],
    "unknown_actions": [
      {
        "action": "string",
        "user_ids": [
          0
        ],
        "payload": {}
      }
    ],
    "error_actions": [
      {
        "action": "string",
        "user_ids": [
          0
        ],
        "payload": {}
      }
    ]
  }'

Responses

201 - Created

Bodyapplication/json
idstring

internal unique identifier of the alert

Example: 2255
enabledbooleanrequired

the active status of the alert

Example: true
targetstring

Date string of next notification

Example: "2021-12-13T16:00:00.000+00:00"
timezonestring
Example: "America/New_York"
alert_namestring
Example: "client decided label"
rrulestring
Example: "DTSTART;TZID=America/New_York:20211201T163000\nRRULE:FREQ=WEEKLY;COUNT=30;INTERVAL=1;WKST=MO"
monitorobject
Example: {"monitor_mode":"INACTIVITY","duration_minutes":10,"inactive_minutes":2,"repeat_monitoring":true}
metaobject
Example: {"anything":"client controlled writable space"}
analytics_tagstring
Example: "caregiver_alert_trace"
no_motion_actionsArray of objects(Root Type for POST_universal_alerts_actions)
Example: [{"action":"fcm_push","user_ids":[5,9],"payload":{"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"no motion","body":"123"},"sound":"Aura_Push_Final.wav","category":"User"}}}}}]
motion_actionsArray of objects(Root Type for POST_universal_alerts_actions)
Example: [{"action":"fcm_push","payload":{"data":{"click_action":"CustomAlertEvent","title":"NO Motion Ua","body":"No Motion was detected during Now","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"motion","body":"123"},"sound":"Aura_Push_Final.wav","category":"User"}}}}}]
unknown_actionsArray of objects(Root Type for POST_universal_alerts_actions)
Example: []
error_actionsArray of objects(Root Type for POST_universal_alerts_actions)
Example: []
uuidstring

Unique id

Example: "Unique alert identifier"
external_idstring

External network id

window_endnumber
window_startinteger

Timestamp showing when monitoring will start

created_atinteger

Alert creation timestamp

next_runany

Timestamp of the next alert trigger. Can be used to monitor the execution of alerts inside the inactivity window.

Response
application/json
{
  "uuid": "Unique alert identifier",
  "enabled": true,
  "target": "2021-12-13T16:00:00.000+00:00",
  "timezone": "America/New_York",
  "alert_name": "client decided label",
  "rrule": "DTSTART;TZID=America/New_York:20211201T163000\nRRULE:FREQ=WEEKLY;COUNT=30;INTERVAL=1;WKST=MO",
  "monitor": {
    "monitor_mode": "INACTIVITY",
    "duration_minutes": 10,
    "inactive_minutes": 2,
    "repeat_monitoring": true
  },
  "meta": {
    "anything": "client controlled writable space"
  },
  "analytics_tag": "caregiver_alert_trace",
  "no_motion_actions": [
    { … }
  ],
  "motion_actions": [
    { … }
  ],
  "unknown_actions": [],
  "error_actions": [],
  "id": 2255
}

Get Universal Alert Status

Request

Returns an array of all alerts associated with the network, but from the view of the job queue, including all the internal state of the job.

The data field of this response contains the client facing alert alert model. This endpoint is to assist with seeing the internals of the job queue.

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/universal-alert/status \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 - OK

Bodyapplication/json
alertsArray of objects
Example: [{"id":"14","data":{"uuid":"eecc4727-707d-48f2-b5e4-3c6aa6745aec","enabled":true,"alert_name":"Preset Rise and Shine","external_id":14,"rrule":"DTSTART;TZID=Europe/London:20220101T080000\r\nRRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU\r\n","monitor":{"monitor_mode":"SIMPLE","duration_minutes":120},"meta":{"alert_type":"RISE_AND_SHINE_PRESET"},"analytics_tag":"riseAndShinePreset","no_motion_actions":[{"action":"fcm_push","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has not begun their day","click_action":"CustomAlertEvent","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"Rise and Shine","body":"Your loved one has not begun their day"},"sound":"Aura_Push_Final.wav","category":"CustomAlertEvent"}}}},"user_ids":[]},{"action":"custom_event","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has not begun their day"}},"user_ids":[]}],"motion_actions":[{"action":"fcm_push","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has begun their day","click_action":"CustomAlertEvent","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"Rise and Shine","body":"Your loved one has begun their day"},"sound":"Aura_Push_Final.wav","category":"CustomAlertEvent"}}}},"user_ids":[]},{"action":"custom_event","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has begun their day"}},"user_ids":[]}],"unknown_actions":[{"action":"fcm_push","payload":{"data":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home","click_action":"CustomAlertEvent","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home"},"sound":"Aura_Push_Final.wav","category":"CustomAlertEvent"}}}},"user_ids":[]},{"action":"custom_event","payload":{"data":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home"}},"user_ids":[]}],"error_actions":[],"timezone":"Europe/London","target":"3/10/2022, 8:00:00 AM - Europe/London","window_end":1646899200000},"progress":0,"attemptsMade":0,"status":"delayed","stacktrace":[],"timestamp":1646861001684,"processingTime":0,"name":"__default__","opts":{"timeout":3000,"attempts":3,"removeOnComplete":true,"delay":38198317,"timestamp":1646861001684},"delay":38198317}]
Response
application/json
{
  "alerts": [
    { … }
  ]
}

Meta

Operations

Administration

Operations