Users

List online users

Get a list of users who have been active within the specified time window. Admin access only.

get/v1/users/online

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/users/online
  • Auth: HTTP bearer

Query parameters

timeWindowinteger
Example:5

Time window in minutes (default: 5). Use 0 for all time. Examples: 0 (all time), 1 (last minute), 5 (last 5 minutes), 60 (last hour), 1440 (last day)

fieldsstring
Example:profile,roles,teams,follows,owns,domains,personas,defaultPersona,personaPreferences

Fields requested in the returned resource

limitinteger

Limit the number users returned. (1 to 1000000, default = 10)

beforestring

Returns list of users before this cursor

afterstring

Returns list of users after this cursor

Response

List of online users

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.