Get Reports of a Message
- Print
- DarkLight
- PDF
Get Reports of a Message
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/moderation.reports
Retrieve all the reports of a single message. A message can have many reports. Permission required: view-moderation-console
Changelog
Version | Description |
---|---|
6.2.0 | Added |
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Query parameters
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
count
integer
How many items to return.
Example50
sort
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}
msgId
stringRequired
The ID of the message to fetch reports for.
Responses
200
OK
Success Example
{
"reports": [
{
"_id": "64ef0f992c26843a68c1f785",
"description": "test report\n",
"reportedBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "test.test",
"name": "test test",
"createdAt": "2023-02-20T13:42:07.119Z"
},
"room": {
"_id": "5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ",
"t": "d"
},
"ts": "2023-08-30T09:44:57.912Z"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}
object
reports
Array of object
object
_id
string
description
string
reportedBy
object
_id
string
username
string
name
string
createdAt
string
room
object
_id
string
t
string
ts
string
count
integer
offset
integer
total
integer
success
boolean
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
Was this article helpful?