Bootstrap

Sidebars examples

Service Documentation





GET ActiveUsers


Overview

Returns details about the currently active player list



Endpoint

https://api.playgenerals.online/env/prod/contract/1/Monitoring/activeusers


Authentication Methods
Method Accepted
No Authentication
Refresh Token
Session Token
Monitor Credentials
API Key

Input Parameters
No input parameters are available for this function.
Name Type Required/Optional Description

HTTP Response Codes
Code Description
200 Success
401 No authorization provided
403 Authorization provided is not valid for this resource

Response Type
Returns a JSON array of objects with key "active_users" with members shown below:

Response Body Fields
Name Type Description
name String Players display name (Not guaranteed to be unique, nor permanent - user can change at any time).
status String The users current activity (e.g. "In Lobby '2v2' - Match In Progress").
client_id String String representing the client in use. Currently only gen_online_60hz and gen_online_30hz are used.
duration String String representing the duration the player has been playing for (e.g. '7 minutes, 33 seconds').