Skip to main content

Guide - Dashboard

When you invite the bot to a server, the bot will automatically create a Dashboard for it.

On this Dashboard you can view and interact with your data in a way that can't be done in Discord. As a result, you may find that the Dashboard has more functionality and more configuration options. Statroles are an example of something that cannot easily be set up in Discord so the Dashboard is the only place to manage them.

important

Sometimes firewalls, such as those on corporate networks, will prevent you from accessing or logging into the website. The easiest way to check is to try to access the site from a device on a different network such as a mobile device. While less stable, the beta website may allow you to connect and is another option to try. VPNs may be another option, but may also be the cause of the problem if you are using one.

Logging In

Like many bots, Statbot uses your Discord account to log you in and check your permissions in a given server.

To login, click "Login" at the top-right of the website, or navigate to https://statbot.net/me.

You know you're logged in when you see your username in the top-right where the "Login" text once was. Clicking here will reveal a menu with som quick navigation and user settings.

info

Statbot will temporarily remember your login using a cookie. It will not be able to do this if you are blocking cookies. In this case, you will need to log in every time you access the site. For heightened security, the cookie will occasionally expire so you will have to log back in from time to time. Logging out through the Statbot site removes any tokens Statbot has cached.

User Settings

Users have a some settings available to them. After logging in, these can be viewed by clicking their username / avatar in the top-right of the website or on the navigation element at the top of the sidebar on the left. There is a shortcut to your Me page, quick access to toggle User Privacy, a link to your premium Subscriptions, and an option to Logout.

There's also a notification bell that will alert you of important updates like changes in status of your Subscriptions, or the progress of a recent User Privacy toggle.

Example

Your /me Page

The /me page is where you can quickly access the dashboards you have permissions to, invite the bot to new servers, see any active or recent premium subscriptions you own, and access your personal settings.

Example

Server Dashboard (Overview)

The Dashboard is split into several sections which show as sections in the sidebar. The server's different types of data is split up between these views to make it easier to find what you need.

Who can view a server's Dashboard is controlled with the Dashboard Access Level setting.

Some sections, like the Drilldowns and Settings page, will only show to members that have special permissions to access to them.

Example

Symbols

Tooltips

Common across the site are icons like that you can hover over for more information about a particular setting or view. These can be very useful to get a brief understanding of what something is, though you will usually find more information in these docs.


Manager Roles (RBAC)

One of the advanced features of Statbot is "Manager Roles" on individual settings. When set, any member having a role in the list will be able to change that setting. On the Settings page, you'll see the following icons which are related to this feature:

  • - No Manager Roles are configured to for this setting.
  • - Manager Roles are configured to for this setting.

Statbot's RBAC (Role-Based Access Control) for settings explained more deeply in the RBAC section. If you are new to the bot, we suggest that you finish the reading this guide first.

Server Dashboard

Depending on the Dashboard Access Level of a server and your own permissions, you may not be able to view a server's Dashboard. Attempting to view a private server will send you to the 404 page. The same will happen if you twy to view a server that doesn't use Statbot.

Member data is hidden to any non-members of a server, even when that server's Dashboard Access Level is set to Public.

All graphs on the Dashboard have an icon in the top-right that allows you to download an image of the graph and a .csv of the data in it, regardless of if you have premium or not.

A small tip is that you can hover over members, channels, and roles to get their Discord ID. This is useful if you looking to filter a member out of stats since member filters in Statbot when the username doesn't find the user.

Important

Statbot records data to UTC (Universal Coordinated Time).
When Precision is set to Day, the Dashboard will start each day from 0:00 UTC.
When Precision is set to Hour, the Dashboard adjusts the time of the data to your local time.

Overview

The Overview screen is a brief overview of many stats of the server and is the only dashboard page that shows Members.

caution

Graphs will be blank or contain a single point for up to 24 hours after you invite the bot, or if your Lookback is set to 1 Day and Precision is not Hourly.

Message & Voice

The Message and Voice pages offer more detailed views of the channel and member statistics.

Each contains the same graph from the Overview page, with a "Top Members" list of up to 250 members, and a "Top Channel" list of up to 500 channels. There are also pie charts that display the same data in a percentage-based view. You can hover over the pie charts for some more information about the slices.

In the top-right of these pages is a toggle for the heatmap which is made accessible through the Data+ upgrade since the heatmaps require hourly data. The heatmap uses hourly data to generate a view that you can use to pinpoint high density areas of activity.

tip

You can unlock an unlimited Top Members table with the Drilldowns upgrade.

Also, with Drilldowns you can quickly access the drilldown pages from the member / channel tables on other dashboard pages by clicking on them in the table.

Status

The Status page displays Status (Online, DnD, Idle, Offline) stats. On this page, the heatmap is displayed separately from the line plot.

This page is one of the places where the Data+ heatmap shines because of the consistent-nature of the data. In the short-term, it can help you see the time of day you have the most members Online. At much longer views achievable with the History upgrade, you can see the impact certain events (such as game patch releases or world events) have had on the overall online presence of your members.

Activity (Premium - Data+)

Activity Tracking and the Activity page is made visible with the Data+ upgrade. The table will show all Activities while the graph will show the top 10 Activities. Like Channels and Members, Activities have a filter that admins can use to Whitelist or Blacklist activities from this view.

Drilldowns (Premium - Drilldowns)

Drilldowns are the ultimate Discord stat experience. They offer highly customizable view on the activity of members and channels, with more views for Activities and Roles coming in the future.

As mentioned previously, features like Drilldowns are not affected by a server's global settings like Lookback and Channel Filter. This means that you are able to use Drilldowns to create custom queries, viewing only the data that you want. You can then share these to other admins making it easy to share your findings.

Settings

If you have permissions to manage any settings in a server, you'll see the Settings link on the sidebar. The Settings page is where you'll find all of Statbot's Settings. It will generally offer the best experience when configuring settings and contains some options that are too complicated to change through the bot. You can find a matrix on where you can configure settings in the Settings section of these docs.

In addition to links to the server's Dashboard and to the Premium Upgrades page, the sidebar contains categories of settings:

  • General: Bot and Dashboard settings.
  • Stats: Settings that control what you see in general stats.
  • Statdocks: The view of all of the server's channel counters and the Statdock editor.
  • Statroles: The view of all of the server's Statroles and the Statrole editor.
  • Permissions: Accessible to only Privileged users. A centralized view of all of Statbot's various access controls.
  • Audit Log: A log of all the changes to Statbot settings, who made them, and when.
  • Subscriptions:All the subscriptions for the server. There is no private information about the subscriptions or the users who are paying for them. If you need to modify your own subscriptions, you can do that on your personal Subscriptions page.