Commands - Management & Tools

Permissions Check!

Make sure Statbot has the following permissions to be able to respond to commands:

• Attach Files Embed Links — Responding to commands. (Both /slash and s?prefix.)
• Send Messages Read Message History — Responding to s?prefix commands.

Usage

These are commands for managing your server's Statbot settings, as well as useful tools for getting non-stat-related information.

Slash

Commands	Description	Usage	Subcommands
/counter	Open Statbot's Statdock Menu. (channel counters)	/counter
/diag	Troubleshoot Statbot misconfigurations in your server.	/diag
/filter	Include / exclude members, channels, and roles from stats.	/filter <subcommand>	See command usage below
/info	Retrieve helpful information.	/info <subcommand>	activity id roles
/settings	Open Statbot's Settings Menu.	/settings

Prefix

Commands	Description	Usage	Subcommands
s?counter	Open Statbot's Statdock Menu. (channel counters)	s?counter
s?diag	Troubleshoot Statbot misconfigurations in your server.	s?diag
s?filter	Include s? exclude members, channels, and roles from stats.	s?filter	See command usage below
s?info	Retrieve helpful information.	s?info <subcommand>	activity id roles
s?settings	Open Statbot's Settings Menu.	s?settings

/counter

Permissions Check!

Statbot needs all the Manage Channels, Send Messages, View Channel, and Connect permissions to create and manage Statdocks. It will need to keep the Manage Channels, View Channel, and Connect permissions to update the channels. You are free to move the Statdock wherever so long as Statbot keeps these permissions.

Opens the Statdocks menu where you can learn about, manage, and create new Statdocks.

• About — Brief information on what Statdocks are.
• Manage — View, Turn Off, Turn On, and Delete existing Statdocks and configurations.
• Setup
  • Quick — Create a small set of the most common Statdocks.
  • Custom — Quick'n'easy preset Statdocks to choose from.
  • Advanced — Offers custom counter settings and setting the channel name.

tip

The Dashboard has many more counter types and customization options available. It also allows you to add up to 4 different counters to a single Statdock.

/diag

Open a menu that let's you check your server for possible misconfigurations that may reduce your Statbot experience.

/filter

Add / remove Users, Channels, and/or Roles from showing in stats.

Slash

Type	Usage	Example
Channels	/filter channels [add, remove] #channel	/filter channels add #off-topic
Channel Type	/filter channels type [whitelist, blacklist]	/filter channels type blacklist
Members / Users	/filter members [add, remove] @user	/filter members add @spammer#1234
Roles (Whitelist)	/filter roles whitelist action:[add, remove] role:@role	/filter roles whitelist action:add role:@Verified
Roles (Blacklist)	/filter roles blacklist action:[add, remove] role:@role	/filter roles blacklist action:add role:@Staff

Prefix

s?prefix options are a little more complicated than /slash commands. We suggested either using the relevant /slash commands, /settings, or the Dashboard. Below are usage patterns and examples for the different filters.

caution

Some patterns below follow option_name: parameter. Spaces between the option_name and parameter are optional, however spaces within the <parameter> are not supported.

To change the Channel Filter type, either use the /filter channel type slash command, the s?settings command, or go to the Dashboard.

Single Filter

You can add any single channel / user / role to a filter it without specifying its type by mentioning it.

Pattern

s?filter [#channel, @user, @role]

Examples

s?filter #off-topic
s?filter @Spammer#1234
s?filter @Staff

Channels

Pattern

s?filter [-]channel:[#channel, name, id]

Examples

Add #off-topic to filter.

s?filter channel:#off-topic

Search for name "off-topic" and add to filter if found. Names do not need to be exact. You will get a prompt if multiple matches are found. Spaces are not supported at this time, however the bot will search for partial matches.

s?filter channel:off-topic

Remove #general from the channel filter.

s?filter -channel:#general

Users

Pattern

s?filter [-]:[@user, username, id]

Examples

Add @Spammer#1234 to member filter.

s?filter user:@Spammer#1234

Search for username "spammer" and add to filter if found. Usernames do not need to be exact. You will get a prompt if multiple matches are found. Spaces are not supported at this time, however the bot will search for partial matches.

s?filter member:spammer

Remove @NotSpammer#1234 from the member filter.

s?filter -user:@NotSpammer#1234

Roles

Pattern

s?filter [-]role:[@role, name, id]

info

Once match(es) are found, you will be prompted to add them to either the Whitelist or Blacklist.

Examples

Add the @Staff role to a filter.

s?filter role:@Staff

Search for name "off-topic" and add to filter if found. Names do not need to be exact. You will get a prompt if multiple matches are found. Spaces are not supported at this time, however the bot will search for partial matches.

s?filter role:staff

Remove @Staff from the role filter.

s?filter -role:#general

info

Filters are explained in more depth on the Settings page. You can change User & Bot, Voice, and Activity filters with the /settings command or on the Dashboard.

/info

Commands for viewing various helpful information about your server.

Subcommands	Description
activity*	Show the activities that a user is currently interacting with.
id**	Shows the server ID, and optionally the IDs of a Discord resources.
roles***	Returns a CSV of the members currently in a set of roles.

* Users must have activities set to show in their Discord status in order for bots to see them. This setting can be found in Discord's user settings under Activity Privacy.

** Supports multiple options at the same time for both types of commands.

*** Members roles in the results will lag behind Discord by a few minutes.

Slash

Subcommands	Usage	Examples
activity	/info activity @user	/info activity @Gamer#1234
id	/info id [@user, #channel, @role]	/info id — /info id @user #channel @role
roles	/info roles @role	/info @CountMe

Prefix

Subcommands	Usage	Examples
activity	s?info activity @user	s?info activity @Gamer#1234
id	s?info id [@user, #channel, @role]	s?info id — s?info id @user #channel @role
roles	s?info roles @roleA [@roleB, ...]*	s?info @CountMe @AndMe

* Returns members that have at least one of the specified roles.

/settings

Open Statbot's Settings Menu, letting you view and manage most of Statbot's settings from Discord.

info

Features like Statdocks (channel counters) and Statroles (auto-roles) are configured in other places. Everything can be found and set on the Dashboard.