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

Retrieve Activity InsightsBeta

Request

Activity Insights provides you activity related data.

Security
ApiKey
Path
network_idintegerrequired

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

Query
start_timenumber

UNIX timestamp, will floor to the nearest 15 minute e.g 20:14 → 20:00. Default is set to 7 days ago. The maximum start_time is one year ago.

end_timenumber

UNIX timestamp, will ceil to the nearest 15 minutes 21:33 → 21:44:59:9999. Default is set to now.

flattenedboolean

If set to true, the results will be provided in a one dimensional array.

Default false
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/v2/{network_id}/activity?start_time=0&end_time=0&flattened=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 OK

Bodyapplication/json
One of:

The results are not flattened

first_bucketnumber(First Bucket)

The UNIX timestamp of the first bucket.

intervalinteger(Bucket Interval)

The number of seconds that a bucket represents.

dataArray of objects(Activity Data)
Response
application/json
{
  "first_bucket": 1743521400,
  "interval": 900,
  "data": [
    0,
    0.559,
    0.36765,
    0.44425,
    null
  ]
}

Sleep InsightsBeta

Request

Sleep Insights provides you sleep related data, including the number of interruptions that have occurred and the sleep and wake times.

Security
ApiKey
Path
network_idintegerrequired

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

Query
start_datestring(date)(Start Date)required

The first date to include within the results.

Example: start_date=2025-03-20
end_datestring(date)(End Date)required

The last date to include within the results.

Example: end_date=2025-04-24
timezonestring(string)(timezone)

Optional If set, the provided value will be used to perform end of day calculations.

Example: timezone=America/Toronto
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/v2/{network_id}/sleep?start_date=2025-03-20&end_date=2025-04-24&timezone=America%2FToronto' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 - OK

Bodyapplication/jsonArray [
hst_interruptionsinteger

Household Sleep Time (HST) interruptions indicates the number of interruptions that had occurred during the sleep time.

Example: 3
sleep_timestring(date-time)

The timestamp that indicates when the the household is considered to be asleep.

Example: "2025-03-19T22:00:00-04:00"
wake_timestring(date-time)

The timestamp that indicates when the household is considered to be awake.

Example: "2025-03-20T09:15:00-04:00"
timezonestring

Timezone used by the sleep and wake times.

Example: "America/Toronto"
house_dayinteger

A counter that tracks the day that is specific to the WiFi Motion network.

Example: 20166
]
Response
application/json
[
  {
    "hst_interruptions": 3,
    "sleep_time": "2025-03-19T22:00:00-04:00",
    "wake_time": "2025-03-20T09:15:00-04:00",
    "timezone": "America/Toronto",
    "house_day": 20166
  },
  {
    "hst_interruptions": 0,
    "sleep_time": "2025-03-20T22:00:00-04:00",
    "wake_time": "2025-03-21T08:15:00-04:00",
    "timezone": "America/Toronto",
    "house_day": 20167
  },
  {
    "hst_interruptions": 0,
    "sleep_time": "2025-03-21T22:00:00-04:00",
    "wake_time": "2025-03-22T09:00:00-04:00",
    "timezone": "America/Toronto",
    "house_day": 20168
  },
  {
    "hst_interruptions": 0,
    "sleep_time": "2025-03-22T22:30:00-04:00",
    "wake_time": "2025-03-23T09:30:00-04:00",
    "timezone": "America/Toronto",
    "house_day": 20169
  },
  {
    "hst_interruptions": 0,
    "sleep_time": "2025-03-23T23:15:00-04:00",
    "wake_time": "2025-03-24T07:30:00-04:00",
    "timezone": "America/Toronto",
    "house_day": 20170
  }
]

Daily Activity InsightsBeta

Request

Provides a percentage of daily activity for the queried days. Please allow for a warmup period of between 2 and 4 hours after first being activated.

Security
ApiKey
Path
network_idintegerrequired

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

Query
start_datestring(date)(Start Date)required

The first date to include within the results.

Example: start_date=2025-03-20
end_datestring(date)(End Date)required

The last date to include within the results.

Example: end_date=2025-04-24
timezonestring(string)(timezone)

Optional If set, the provided value will be used to perform end of day calculations.

Example: timezone=America/Toronto
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/insights/v2/{network_id}/activity/daily?start_date=2025-03-20&end_date=2025-04-24&timezone=America%2FToronto' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

200 - OK

Bodyapplication/jsonArray [
datestring

Date that the results are related to.

percent_activenumber(float)

Percentage of time that activity occurred within the sample.

tsinteger

Epoch timestamp.

]
Response
application/json
[
  {
    "date": "2025-03-19",
    "percent_active": 0.10266202688217163,
    "ts": 1742356800
  },
  {
    "date": "2025-03-20",
    "percent_active": 0.19775460163752237,
    "ts": 1742443200
  },
  {
    "date": "2025-03-21",
    "percent_active": 0.21174768606821695,
    "ts": 1742529600
  },
  {
    "date": "2025-03-22",
    "percent_active": 0.1452083388964335,
    "ts": 1742616000
  }
]

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations