Get the Most Popular Channels

Prev Next
Get
/api/v1/engagement-dashboard/messages/top-five-popular-channels
Premium tag

Retrieves the top 5 popular channels in your workspace by the number of messages sent. It highlights the number of messages sent in private channels, private chats, and public channels.

Permission required: view-engagement-dashboard

Version Description
3.1.0 Added
Header parameters
X-Auth-Token
stringRequired

The token of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The user ID of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
start
stringRequired

The start date.

Example2023-10-29T14:48:00.000Z
end
stringRequired

The end date.

Example2023-11-05T14:48:00.000Z
Responses
200
400
401
403

t denotes the type of room where the messages are sent. The types of rooms can be any of the following:

  • d represents Private Chats
  • c represents Public Channels
  • p represents Private Channels"
Collapse all
object
channels
Array of object
object
messages
integer
t
string
name
string
usernames
Array of object
object
success
boolean
Tags