Skip to main content

Get aggregated derived events

GET 
/:customer_id/users/:uid/derived-events/aggregated

Get aggregated derived events for a user

Request​

Path Parameters

    customer_id Customer Idrequired

    Id of the tenant

    uid uuidrequired

    Id of the user

Query Parameters

    limit Limit

    Possible values: <= 1000

    Default value: 100

    Pagination. Max number of entries returned.

    offset Offset

    Pagination. Offset.

    device_id uuid

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

    aggregation any

    Aggregation bucket size

    start_date date-time

    Start time, timestamp with tz

    end_date date-time

    End time, timestamp with tz

    direction Direction

    Possible values: [asc, desc]

    Default value: desc

    Ascending or descending in time

    omit_empty_buckets Omit Empty Buckets

    Omit empty buckets

    fields string[]

    Possible values: [device_id, count, min_burst_size, max_burst_size, avg_burst_size, min_duration, max_duration, avg_duration]

    List fields to return

    metrics DerivedMetricsEnum[]

    Possible values: [cough_burst, cough_oasis]

    Metric(s) fetched

Responses​

Successful response

Schema
    events object[]required
  • Array [
    • time date-timerequired

    Start time of this aggregation bucket.

    time_tracked_s Time Tracked Srequired

    Seconds tracked inside this aggregation bucket. ie. If aggregation='hour' the maximum would be 60(minutes)*60(seconds).

    data objectrequired

    Dict containing an entry for each metric requested (if available in this aggregation bucket).

    property name* PerMetricAggregatedData
    device_id uuid[]nullablerequired

    List of device ids that contributed to this aggregation

    count Countnullablerequired

    Count of events that occurred during this aggregation bucket

    min_burst_size Min Burst Sizenullablerequired

    If the metric is 'XXX_burst', this is the minimum burst size registered during this aggregation bucket

    max_burst_size Max Burst Sizenullablerequired

    If the metric is 'XXX_burst', this is the maximum burst size registered during this aggregation bucket

    avg_burst_size Avg Burst Sizenullablerequired

    If the metric is 'XXX_burst', this is the average burst size registered during this aggregation bucket

    min_duration Min Durationnullablerequired

    Minimum duration of events registered during this aggregation bucket, if the selected metric has duration

    max_duration Max Durationnullablerequired

    Maximum duration of events registered during this aggregation bucket, if the selected metric has duration

    avg_duration Avg Durationnullablerequired

    Average duration of events registered during this aggregation bucket, if the selected metric has duration

  • ]
Loading...