Get Channel Counters

Prev Next
Get
/api/v1/channels.counters

Gets channel counter 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

The user ID.

ExampleRtycPC29hqLJfT9xj
Responses
200

OK

Note

  • joined boolean flag whether the user has joined the room or not.
  • members is the count of current room members.
  • unreads is the count of unread messages for the specified user (for the calling user or the provided user ID).
  • unreadsFrom is the start date-time of unread interval for the specified user.
  • msgs is the count of messages in the room.
  • latest is the end date-time of unread interval for the specified user (or date-time of last posted message).
  • userMentions is the count of user mentions in messages.
Example
{
  "joined": true,
  "members": 23,
  "unreads": 2,
  "unreadsFrom": "2023-09-12T16:33:11.644Z",
  "msgs": 7345,
  "latest": "2023-09-25T22:50:07.979Z",
  "userMentions": 0,
  "success": true
}
object
joined
boolean
members
integer
unreads
integer
unreadsFrom
string
msgs
integer
latest
string
userMentions
integer
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string