Skip to content

Cognitive Systems App Cloud API

The AppCloud APIs are used by mobile applications to communicate with the Cognitive Systems Infrastructure.

Download OpenAPI description
app_cloud.json
app_cloud.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/

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

[BETA] Retrieve Activity Insights

Request

[BETA] Activity Insights provides you activity related data.

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.

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/app_cloud/insights/v2/activity?start_time=0&end_time=0&flattened=false'

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
  ]
}

Household Activity

Request

Available in App Cloud v1-3-22 and above. Requires the Home-Insights Microservice enabled within MNS.

Path
queried_daysnumberrequired

the number of days to query, when omitted assumes 7 days

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/activity/{queried_days}'

Responses

Bodyapplication/json
queried_daysinteger

the number of days queried

Example: 7
activityArray of objects
Example: [{"house_day":18960,"activity_minutes":214,"day_ts":1638162000},{"house_day":18961,"activity_minutes":142,"day_ts":1638248400},{"house_day":18962,"activity_minutes":510,"day_ts":1638334800},{"house_day":18963,"activity_minutes":55,"day_ts":1638421200},{"house_day":18964,"activity_minutes":49,"day_ts":1638507600},{"house_day":18965,"activity_minutes":182,"day_ts":1638594000},{"house_day":18966,"activity_minutes":86,"day_ts":1638680400}]
string
Response
application/json
{
  "queried_days": 7,
  "activity": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations