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

Network motion-intensity history

Request

Retrieve time series array of motion-intensity values across the whole network

Security
ApiKey
Path
network_idintegerrequired

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

Query
frominteger

UTC timestamp in seconds

tointeger

UTC timestamp in seconds

bucketinteger

Side of data series buckets return in seconds

sumfuncstring

Summary function used to aggregate data when bucket size exceeds storage resolution (5sec).

Default "max"
Enum"max""min""avg"
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/motion/history/intensity?from=0&to=0&bucket=0&sumfunc=max' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [Array [
Any of:
number(timestamp)
]]
Response
application/json
[
  [
    [ … ],
    [ … ],
    [ … ],
    [ … ],
    [ … ],
    [ … ]
  ]
]

Network motion-density history

Request

Retrieve time series array of motion-density values across the whole network.

Security
ApiKey
Path
network_idintegerrequired

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

Query
frominteger

The UTC timestamp of the oldest report client already has in seconds

tointeger

The UTC timestamp of the latest report client is interested in, current time will be used if not provided

bucketinteger

The number of seconds in density calculation window; returned data points represent % of non-zero intensity values in the window.

Default 3600
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/motion/history/density?from=0&to=0&bucket=3600' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [Array [
Any of:
number(timestamp)
]]
Response
application/json
[
  [
    [ … ],
    [ … ],
    [ … ],
    [ … ],
    [ … ],
    [ … ]
  ]
]

Motion BlocksBeta

Request

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID

Query
frominteger

UTC unix timestamp to search motion from.

tointeger

UTC unix timestamp to query motion until.

density_bucketinteger>= 5

Bucket size of the returned motion block segments in seconds.

Default 120
state_bucketinteger>= 5

Bucket size for motion state values. Larger sizes will tend to ignore shorter periods of lesser states.

Default 1800
statesinteger

Which states to include, values are any combination of [0,1,2,3]. Response will return blocks of single state, i.e. continuous motion while moving from 2 to 3, will result in motion blocks for 2 and for 3 individually. Default is [2].

Enum0123
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/motion/history/state_blocks?from=0&to=0&density_bucket=120&state_bucket=1800&states=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Returns any array of motion blocks. Each block summarizes locations and devices seen, as well as the time range and motion_state of the block. For each density_bucket sized time period, a breakdown of location and density is listed. The breakdown is captured in three parallel lists of locations, devices and densities. Friendly names for locations and devices are used when available, defaulting to MAC addresses (without the ":" when not available.

Bodyapplication/jsonArray [
devicesArray of strings
location_historyArray of objects
locationsArray of strings
startinteger
stateinteger
stopinteger
]
Response
application/json
[
  {
    "devices": [ … ],
    "location_history": [ … ],
    "locations": [ … ],
    "start": 1708632120,
    "state": 0,
    "stop": 1708632960
  }
]

Live Motion

Operations

Events

Operations

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