Get
/api/v1/engagement-dashboard/channels/list
Retrieve all channels and the number of messages in each channel within a specific period.
Permission required: view-engagement-dashboard
Changelog
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
Example50
offset
integer
Number of items to "skip" in the query, i.e. requests return count
items, skipping the first offset
items. Refer to the official documentation to learn more.
hideRoomsWithNoActivity
boolean
Enable this option to remove rooms without any activity from the response. This parameter has been deprecated and is scheduled for removal in the 7.0.0 release. After the removal, this endpoint will automatically omit such inactive rooms from the response.
Responses
200
OK
Success Example
{
"channels": [
{
"room": {
"_id": "string",
"name": "string",
"ts": "string",
"t": "string",
"_updatedAt": "string"
},
"messages": 0,
"lastWeekMessages": 0,
"diffFromLastWeek": 0
}
],
"total": 0,
"offset": 0,
"count": 0,
"success": true
}
object
channels
Array of object
object
room
object
_id
string
name
string
ts
string
t
string
_updatedAt
string
messages
integer
lastWeekMessages
integer
diffFromLastWeek
integer
total
integer
offset
integer
count
integer
success
boolean
400
Bad Request
Missing key
{
"success": false,
"error": "Match error: Missing key 'start'"
}
Example 2
{
"success": false,
"error": "Match error: Failed Match.Where validation in field start"
}
object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}
object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string