Skip to main content

Get derived events (group)

GET 
/:customer_id/groups/:group_id/users/:uid/derived-events

Get derived events for 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

    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.

    metric any

    Metric fetched

    from date-time

    Start time, timestamp with tz

    to date-time

    End time, timestamp with tz

    search_by Search By

    Possible values: [start_time, end_time]

    Default value: start_time

    Search by start or end time

    direction Direction

    Possible values: [asc, desc]

    Default value: desc

    Ascending or descending in time

    fields string[]

    Possible values: [uid, device_id, metric, start_time, end_time, burst_size, duration_s]

    Comma separated list of fields to return

    order_by Order By

    Possible values: [uid, device_id, metric, start_time, end_time, burst_size, duration_s]

    Default value: start_time

    Field to order by

Responses​

Successful response

Schema
    events object[]required
  • Array [
    • uid uuid

    Id of the user

    device_id uuid

    Id of the device

    metric object
    start_time date-time

    Local time (for the user) at which the event happened

    end_time date-time

    Utc time at which the event happened

    burst_size Burst Size

    Size of the burst if metric is of type burst.

    duration_s Duration S

    Duration of the event in seconds

  • ]
Loading...