Get a cough clock (group)

GET 
/:customer_id/groups/:group_id/users/:uid/insights/clock

Get a cough clock for the requested time period of a user in a group

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

group_id Group Idrequired

Id of the group

uid uuidrequired

Id of the user

Query Parameters

from date-timerequired

Start time, timestamp with tz

to date-timerequired

End time, timestamp with tz

device_id uuid

Id of the device to use, if omitted calculated across all devices.

metric any

Metric used to calculate the clock

Responses

200

Successful response

application/json

Schema

Schema

clock object[]required
Possible values: >= 24, <= 24
List of results for each hour of the day
Array [
hour Hourrequired
Hour of the day, 0 to 23
time_tracked_s Time Tracked Srequired
Total time tracked at that hour of the day across the requested period
time_in_state_s Time In State Snullablerequired
Total time in state at that hour of the day across the requested period. Only when metric is oasis
count Countnullablerequired
Total number of events which happened at that hour of the day across the requested period. Not available when metric is oasis.
]

Example (from schema)

{
  "clock": [
    {
      "hour": 0,
      "time_tracked_s": 0,
      "time_in_state_s": 0,
      "count": 0
    }
  ]
}

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

{
  "message": "string",
  "errors": [
    null
  ]
}

Loading...