Commands and permissions
Everything /analyse can do in game and in the console, and the permissions that control it.
The root command is /analyse, with the alias /an. It works in the console and in game.
Options
Options are key=value pairs in any order. Quote values that contain spaces:
/analyse payment user=Steve amount=9.99 item="VIP Rank"- Ranges (
range=):today,7d,30d,90d. Most commands default to7d. - Breakdowns (
by=):sources,types,campaigns,codes,countries.
Stats
| Command | Permission | What it shows |
|---|---|---|
/analyse | analyse.stats | The dashboard menu for players on modern Paper, an overview in chat elsewhere |
/analyse overview [range=7d] | analyse.stats | Joins, unique and new players, playtime, revenue, D1 and D7 retention, top source |
/analyse online | analyse.stats | Players online per server, plus today's totals |
/analyse player user=<name> | analyse.stats | A player's profile. user= is optional: /analyse player Steve works too |
/analyse acquisition [by=sources] [range=7d] | analyse.stats | Where players come from |
/analyse revenue [range=7d] | analyse.stats | Revenue, purchases and best-selling items |
Stats come from the same numbers as the dashboard and are cached for 30 seconds.
Recording data
| Command | Permission | What it does |
|---|---|---|
/analyse payment user=<name> amount=<n> [currency=EUR] [item="VIP Rank"] [creatorcode=<code>] [id=<txn>] [quantity=<n>] | analyse.write | Records a purchase made outside a store webhook |
/analyse credits user=<name> item=<id> amount=<n> [type=spent|earned] | analyse.write | Records in-game credits spent or earned. type defaults to spent |
/analyse track user=<name> event=<name> [key=value ...] | analyse.write | Sends a custom event with properties |
/analyse set user=<name> key=value [key=value ...] | analyse.write | Sets player properties. An empty value unsets one |
Notes on payments
- Without
currency, thepayment-currencyfromconfig.ymlis used (USD by default). - Give an
id(your transaction id) so running the same command twice does not count the purchase twice. Without one, every run is a new purchase. - These commands are handy from store "run command on purchase" hooks. If your store is Tebex, PayNow or CraftingStore, a store integration is usually better: it also tracks refunds and chargebacks.
Admin
| Command | Permission | What it does |
|---|---|---|
/analyse connect [force=true] | analyse.admin | Pairs the server with a game. See Pair with /analyse connect |
/analyse status | analyse.admin | Connection, game, deployment and delivery counters, then a fresh key check |
/analyse reload | analyse.admin | Re-reads config.yml, messages.yml and the menu files |
/analyse import [plan|domainstats|cancel] | analyse.admin | Imports history from Plan or campaigns from DomainStats. See Import |
/analyse help [page] | Everyone | The commands you are allowed to use, 7 per page |
Permissions
All permissions default to server operators.
| Permission | Grants |
|---|---|
analyse.stats | The overview, who is online, breakdowns, revenue and player profiles |
analyse.write | Recording payments and credits, sending events and setting player properties |
analyse.admin | Status, reload, pairing, imports and the key check |
analyse.alerts | Receiving dashboard alerts in chat, when in-game staff messages are on |
To get alerts in game, open the game's Settings, Alerts & digests in the dashboard and turn on In-game staff message. Staff with analyse.alerts see alerts in chat. See Delivery channels.