You can submit posts and users that have been reported on your platform to Moderation Dashboard through the Reports API. You can choose to send these reported tasks straight to the Review Feed or directly take enforcement actions on them.

📘

Note:

Reported tasks can only be submitted to the Reports API if they have been submitted through the Moderation Dashboard API first. You cannot directly submit content to Moderation Dashboard through the Reports API. Alternatively, you can submit a reports object through the v2 endpoint simultaneously, which will run both post and report rule flows.

Configure Report Categories

Before sending reports through the Reports API, you will need to configure report categories to match the current set of report categories within your platform. On the Rules page, click “Configure Report Categories” in the top right to open the creation interface.

First, you will need to specify the category value and display name. The category value will be the key you will use in the Reports API when defining the report_categories field. The corresponding display name is how the category will be displayed across Moderation Dashboard. Lastly, you will need to specify whether the report category applies to either users, posts or both, on your platform.

Once you have created all of your report categories, you can start submitting Reports to the Dashboard and create rules based on these categories.

Submitting Reports to the Reports API

Sync Request

https://api.hivemoderation.com/api/v1/report

Form Data

curl --location --request POST 'https://api.hivemoderation.com/api/v1/report' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'authorization: token 123' \
--data-raw '{
  "post_id": "post_id_123",
  "report_categories": ["hate"],
  "report_reason": "This post is inappropriate",
  "reporter_id": "reporter_id_123"
}'

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.hivemoderation.com/api/v1/report',
  'headers': {
    'accept': 'application/json',
    'Content-Type': 'application/json',
    'authorization': 'token lGqTHDletUtTvEsONMTqWBA'
  },
  body: JSON.stringify({
    "post_id": "post_id_123",
    "report_categories": [
      "hate"
    ],
    "report_reason": "This post is inappropriate",
    "reporter_id": "reporter_id_123"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "https://api.hivemoderation.com/api/v1/report"

payload = json.dumps({
  "post_id": "post_id_123",
  "report_categories": [
    "hate"
  ],
  "report_reason": "This post is inappropriate",
  "reporter_id": "reporter_id_123"
})
headers = {
  'accept': 'application/json',
  'Content-Type': 'application/json',
  'authorization': 'token lGqTHDletUtTvEsONMTqWBA'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"post_id\": \"post_id_123\",\n  \"report_categories\": [\"hate\"],\n  \"report_reason\": \"This post is inappropriate\",\n  \"reporter_id\": \"reporter_id_123\"\n}");
Request request = new Request.Builder()
  .url("https://api.hivemoderation.com/api/v1/report")
  .method("POST", body)
  .addHeader("accept", "application/json")
  .addHeader("Content-Type", "application/json")
  .addHeader("authorization", "token lGqTHDletUtTvEsONMTqWBA")
  .build();
Response response = client.newCall(request).execute();

Create Report Rules

On the Rules page, you can create rules for reported posts and users. When a post or user is reported through the Reports API, if all conditions in a report rule are matched, Moderation Dashboard will trigger the rule and take any corresponding action.

For example, the rule below will flag any post with five or more “suggestive” reports for review. Then, in the Review Feed, a moderator can decide to publish the post if it doesn’t violate any policies or permanently delete it.

If you want to take action on all reports regardless of the report category, you can select “Post reported (any reason)”.

View Reports on the Dashboard

Content Feed

If a post has been reported, all content associated with the post will show a yellow circle on the content row and will display the number of reports submitted. Click into a content row to view the specific report categories, report reasons, and reporter ids.

User Feed

Similar to post reports, if a user has been reported, a yellow circle will appear on the user row displaying the number of reports submitted for that users. Click into a user row to view the specific report categories, report reasons, and reporter IDs.

Reports in the Review Feed

Reported users and posts that are flagged for human review will show up on the Review Feed page under the Reports Feed. Only reported users and posts will be displayed in the reports feed. All other review tasks will be displayed in the General Review Feed.