Documentation

Support

Moderation dashboard

Moderation dashboard

Moderation API

Use the Moderation API to integrate moderation functionality.
Read time 1 minuteLast updated 2 days ago

The Moderation API allows you to handle incidents with the Moderation service through automated processes.

Available endpoints

Endpoints are available for the following actions:
  • Retrieve a paginated, filtered, and sorted list of incidents.
  • Retrieve a specific incident.
  • Update an incident.
  • Retrieve player action types (actions that can be applied to a player).
  • Retrieve a list of filtered actions.
  • Apply an action to a player.
  • Update or revoke an action applied to a player.
  • Retrieve a paginated, filtered, and sorted list of players.
Full API documentation is available in the services docs. This API supports service accounts for authentication.

Incident resolution workflow

  1. Create player action
    • For time based actions you must ensure that the player doesn't currently have an active action of this type. If one is still active you must first revoke it.
    • Create an action for the player.
  2. Update the incident status to resolved.