Documentation
Pick the job you came to do.
Most read
Getting started
Learn what the parts are, then pair your first server.
- Architecture and overviewHow the connector, the ingest API, and the dashboard fit together, and what leaves your servers.
- QuickstartThe four steps: pick a plan, install the loader, pair, see your data.
- Switching from PlanBring your player history over from Plan (Player Analytics) with one console command. What comes over, what does not, and why it is safe to run again.
Connector setup
Install the connector on Velocity, BungeeCord, Paper, Folia, Spigot, or a Bedrock bridge.
- Velocity proxy setupInstall and configure the Velocity connector, which owns hostname attribution and session tracking.
- Several proxies and regionsRun the connector on more than one Velocity or BungeeCord proxy, in one region or several, and still count every player once.
- BungeeCord and Waterfall setupInstall the connector on a BungeeCord or Waterfall proxy. It reads the join address and owns sessions, the same as on Velocity.
- Paper, Purpur, Folia and Spigot setupInstall the connector on backend servers for heartbeats, in game events, confirmed bans, and login confirmation.
- Folia supportFolia runs the same Paper loader and connector. Every read of the world happens on the thread that owns it.
- Geyser and FloodgateHow Bedrock, premium Java, and cracked Java players are kept apart so identities never collide.
Attribution and growth
Give every creator an address and read the joins it brings.
Revenue
Connect your stores and credit purchases back to a source.
- Tebex store integrationConnect your Tebex store with a signed webhook so purchases land against the source that brought the buyer.
- CraftingStore integrationConnect a CraftingStore webstore with a signed webhook so its sales land in Revenue next to your other stores.
- Your own PayPalSell through your own PayPal account and send every capture, refund and dispute to Revenue with a verified webhook.
- Your own StripeSell through your own Stripe account and send every paid checkout, renewal, refund and dispute to Revenue with a signed webhook.
- Yearly revenue reportTwelve calendar months of gross, refunds, net and buyers, plus revenue by package, counted once per purchase.
Retention and metrics
See who comes back and how a session is counted.
- The 7 day return ruleExactly what counts as a returning player, why the rule changes on a network that runs a login plugin, and how Day 1, Day 7, and Day 30 differ.
- Churn risk and cohortsDay 1, Day 7 and Day 30 return by day, week or month of first join, and a score that shows which regulars may be about to leave, and why.
- Retention AutopilotWhere new players drop off in their first session, which join address stopped bringing players back, and what to check first. On the Unlimited plan.
- Sessions and server healthWhat a session record holds, and what the heartbeat reports about each server.
Votes
Count server list votes and see which sites bring players back.
Fair play
Read confirmed cheat bans by source.
Staff tools
Look up one player and keep notes for your team.
Places
See which WorldGuard regions players spend time in, map where they stand and quit, and see it all on your rendered world.
- WorldGuard regionsSee which WorldGuard regions players spend time in, where new players spend their first session, and where they quit.
- Heatmaps and session pathsMap where players spend time and where they quit, one chunk at a time, and see which servers they move through before they leave.
- World mapSee your world from above with where players spend time, where they quit and your regions drawn on it, in 2D or 3D. Experimental.
Server performance
Find what makes a server lag and open the Spark report.
Connector API
Post your own events or read your numbers from code.
- Ingest API referenceThe HTTP endpoints the connector calls: pairing, sessions, heartbeats, in game events, confirmed bans, votes, heat, custom events, and batches.
- Custom eventsSend events from your own plugins, site or Discord bot, such as a crate opened or a quest done, and follow players from one event to the next.
- Export APIPull players, sessions, purchases from every store, votes and custom events out as JSON or CSV, one page at a time, for any range of days.
- Network API and webhooksRead your own numbers with a scoped key, export CSV, and receive signed alerts on your own endpoint. The read API and webhooks are on Unlimited.
Alerts
Get alerts in a channel on your own Discord server.
Sharing
Publish a status page, a badge, or an anonymous case study.
- Public status page and badgesPublish a status page your players can open without an account, and drop a live badge into a website or a forum signature.
- Anonymous case studiesShare your growth as a public case study with no name on it. Only relative curves, week numbers and a size band leave your network, and you can stop at any time.
Settings
Find any block in Settings and what it changes.
Account
Plans, payment, and cancelling.