Get all user stats

GET 
/:customer_id/groups/:group_id/users/stats

Get stats for all users in a group

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

group_id Group Idrequired

Id of the group

Query Parameters

limit Limit

Possible values: <= 500

Default value: 10

Pagination. Max number of entries returned.

offset Offset

Pagination. Offset.

order_by Order By

Possible values: [uid, alias, external_id, first_active_local_time, first_active_utc, last_active_local_time, last_active_utc, last_sync_time_utc]

Default value: uid

Order by field. Default is uid.

direction Direction

Possible values: [asc, desc]

Default value: asc

Order direction. Default is asc.

Responses

200

Successful response

application/json

Schema

Schema

stats object[]required
Array [
uid uuidrequired
Id of the user.
alias Aliasnullablerequired
Optional alias of the user.
external_id External Idnullablerequired
Optional external id of the user.
utc_offset Utc Offsetnullablerequired
UTC offset of the user in minutes.
first_active_local_time date-timenullablerequired
Local time of the first event sent to insights for this user.
first_active_utc date-timenullablerequired
Time of the first event sent to insights for this user.
last_active_local_time date-timenullablerequired
Local time of the last event sent to insights for this user.
last_active_utc date-timenullablerequired
Time of the last event sent to insights for this user.
last_sync_time_utc date-timenullablerequired
Time of the last sync.
total_time_tracked_s Total Time Tracked Srequired
Amount of seconds tracked in the lifetime of this user.
num_events objectrequired
Number of events tracked for this user.
property name* integer
periods object[]required
List of periods for this user.
Array [
name Namerequired
Name of the active period.
group_id Group Idrequired
Id of the group.
start_time_local date-timenullablerequired
Local start time of the active period.
end_time_local date-timenullablerequired
Local end time of the active period.
start_time_utc date-timenullablerequired
Start time of the active period.
end_time_utc date-timenullablerequired
End time of the active period.
tags string[]required
List of tags attached to the active period.
time_tracked_s Time Tracked Snullablerequired
Monitored time in period.
is_completed Is Completedrequired
Whether the period is completed.
]
]

Example (from schema)

{
  "stats": [
    {
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "string",
      "external_id": "string",
      "utc_offset": 0,
      "first_active_local_time": "2024-12-03T11:32:12.465Z",
      "first_active_utc": "2024-12-03T11:32:12.465Z",
      "last_active_local_time": "2024-12-03T11:32:12.465Z",
      "last_active_utc": "2024-12-03T11:32:12.465Z",
      "last_sync_time_utc": "2024-12-03T11:32:12.465Z",
      "total_time_tracked_s": 0,
      "num_events": {},
      "periods": [
        {
          "name": "string",
          "group_id": "string",
          "start_time_local": "2024-12-03T11:32:12.465Z",
          "end_time_local": "2024-12-03T11:32:12.465Z",
          "start_time_utc": "2024-12-03T11:32:12.465Z",
          "end_time_utc": "2024-12-03T11:32:12.465Z",
          "tags": [
            "string"
          ],
          "time_tracked_s": 0,
          "is_completed": true
        }
      ]
    }
  ]
}

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

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

Loading...