Skip to main content

Get raw events

GET 
/:customer_id/users/:uid/events

Get 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.

    metric any

    Metric fetched

    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

    fields string[]

    Possible values: [uid, device_id, metric, time, utc_time, sensor, value1, value2]

    List fields to return

    order_by Order By

    Possible values: [uid, device_id, metric, time, utc_time, sensor, value1, value2]

    Default value: time

    Field to order by

Responses​

Successful response

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

    Id of the user

    device_id uuidnullablerequired

    Id of the device

    metric object
    time date-timenullablerequired

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

    utc_time date-timenullablerequired

    Utc time at which the event happened

    sensor Sensornullablerequired

    Name of the sensor which captured the event

    value1 Value1nullablerequired

    First value associated to the event. The meaning of the value depends on the metric type.

    value2 Value2nullablerequired

    Second value associated to the event. The meaning of the value depends on the metric type.

  • ]
Loading...