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-state history

Request

Retrieve time series array of motion-state 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, defaults to current time

bucketinteger

Size of data series buckets returned in seconds

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

Responses

200 - OK

State values indicate the following:

  • 0 Not armed and not tripped

  • 1 Not armed and tripped

  • 2 Armed and not tripped

  • 3 Armed and tripped

Bodyapplication/jsonArray [
object
]
Response
application/json
[
  [
    0,
    1709316000
  ],
  [
    1,
    1709319600
  ],
  [
    1,
    1709323200
  ],
  [
    2,
    1709326800
  ],
  [
    3,
    1709330400
  ],
  [
    4,
    1709334000
  ]
]

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
[
  [
    [ … ],
    [ … ],
    [ … ],
    [ … ],
    [ … ],
    [ … ]
  ]
]

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