Get Group Counters
- Print
- DarkLight
- PDF
Get Group Counters
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/groups.counters
Get group counters for the authenticated user.
Permission required: view-room-administration
Changelog
| Version | Description |
|---|---|
| 0.65.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
roomId
string
The room id. It is required if the roomName is not provided.
Exampledlpfuijw7ej
roomName
string
The room name. It is required if the roomId is not provided.
Examplegeneral
userId
string
Counters for provided user ID (need to have a view-room-administration right for calling user).
Responses
200
OK
Note:
- joined - boolean flag that shows that user is joined the room or not
- members - count of current room members
- unreads - count of unread messages for specified user (calling user or provided userId)
- unreadsFrom - start date-time of unread interval for specified user
- msgs - count of messages in the room
- latest - end date-time of unread interval for specified user (or date-time of last posted message)
- userMentions - count of user mentions in messages"
Success
{
"joined": true,
"members": 1,
"unreads": 1,
"unreadsFrom": "2018-02-18T21:51:20.091Z",
"msgs": 1,
"latest": "2018-02-23T17:20:17.345Z",
"userMentions": 0,
"success": true
}object
joined
boolean
members
integer
unreads
integer
unreadsFrom
string
msgs
integer
latest
string
userMentions
integer
success
boolean
Was this article helpful?