Get Reports of a Message

Prev Next
Get
/api/v1/moderation.reports

Retrieve all the reports of a single message. A message can have many reports. Permission required: view-moderation-console

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. Refer to the official documentation to learn more.

Example50
count
integer

How many items to return. Refer to the official documentation to learn more.

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}. Refer to the official documentation to learn more.

msgId
stringRequired

The ID of the message to fetch reports for.

Responses
200
401
403

OK

Collapse all
object
reports
Array of object
object
_id
string
description
string
reportedBy
object
room
object
ts
string
count
integer
offset
integer
total
integer
success
boolean