Track custom events and funnels
Custom events your own plugins send, the Events page that charts them, and journeys (funnels) built from custom and agent events.
In a few minutes you can see how often your own plugins' events fire (crates opened, quests finished, duels won) and follow players through the steps you expect them to take, such as joined, opened the shop, bought a rank.
Before you start#
- A linked server, see Connect your server.
- For your own events, a plugin that calls the agent's API (one line, below) and the Custom events module on in the workspace's What the plugin collects settings. With the module off, the agent drops them.
- To create or edit journeys, the Create campaigns, map hostnames and edit journeys permission
(
manage_campaigns). See Team and settings.
Steps#
See an event#
Send it from your plugin
One line is enough. The rules, the threading and a full example are on the API page.
ExyliaAnalytics.track(player.getUniqueId(), "crate_open", Map.of("crate", "legendary"));Open Events
Go to Activity › Events (titled Events from other plugins). Pick the event from the Event list; each entry shows how often it fired, how many players fired it and when it was last seen.
Break it down
Read The event over time, then the breakdown By each property the event carries.
Build a journey#
A journey (the older name is funnel) is an ordered list of events a player is expected to walk through, and a window they have to do it in. Each step shows how many players got that far and how many were lost on the way.
Open Journeys
Go to Activity › Journeys. Under Your journeys, start New journey. You can begin from a template (New players coming back, Store visit to purchase), From scratch, or copy an existing journey.
Name it and set the window
Give it a Name (up to 40 characters) and pick how long a player has to reach the last step, counted from their first one: 1, 6, 12 or 24 hours, 2 days, 1 week or 30 days.
Add the steps
Add up to 8 steps from Quick add or Add another event…, then reorder them with Move up and Move down. A step is one of your events (Your events), one of the plugin's own events (Plugin events) or a ready-made step (Built-in steps: First session, First chat message, First command, First advancement, Came back another day, Still playing a week later, First purchase).
Choose who can enter
Under Who can enter?, pick Any player or New players only.
Create it
Click Create journey. It opens with its real numbers.
Check that it works#
A custom event shows up on the Events page within a minute of being sent, with a count and a player count. A journey shows Entered, Completed and Finished for the selected range, and each step has a bar with the players who reached it. A journey counts nothing until it has two steps, and a step with no data yet reads 0 until something sends its event.
Going further#
Narrow a step to one value#
When you add a step, Count only one kind of event limits it to events that carry a given detail, such as
crate = legendary: pick the property under Only when and the value under Is (or Any value).
Find who stopped#
On a journey's page, Who stopped where lists the players who reached a step and never made the next one, most recent first. Pick the step under Stopped after.
Built-in journeys#
Built-in journeys are ready to read with no setup and are read-only: First steps, First purchase and Voters, plus one for each ExyliaJourney journey you run. Use Duplicate and edit to change the steps of one.
How the numbers are defined
| Metric | Definition |
|---|---|
| Entered | Players who sent the first step in the range. |
| Completed | Players who then sent every step, in order, within the window of their first step. |
| Finished (conversion) | Completed ÷ entered. |
| Of previous step | Players who reached a step ÷ players who reached the one before it. |
| Typical time | Median time from first step to last, over the players who finished. |
Events that are not steps never break the chain. Journeys and the Events page read the raw event log, which is kept for 90 days, so they never look back further. A journey is deleted with Delete journey; no event data goes with it.
Limits
- A journey needs at least two steps and holds at most 8.
- Names are unique per workspace and at most 40 characters.
- The steps you can pick come from the events seen in the selected range, plus the built-in ones.
Something missing on this page? Tell us on Discord