Engagement Markers
Markers are used to track player interactions and events in your experience. This data can be used to create heatmaps and other visualizations to help you understand how players are interacting with your experience.
To send markers to Gamebeast, you must first fetch the Markers service from the Gamebeast SDK. You can then use the provided :SendMarker methods to send markers to Gamebeast with your custom data.
By default, Gamebeast also sends a number of built-in markers to track generic player interactions, such as player joins, leaves, and chats.
Types of markers
There are two types of markers you can send to Gamebeast, Player and Global markers. All of these marker types can be visualized through the query builder.
Player markers
Player markers are used to track player-specific interactions and events. These markers are tied to a specific player and can be used to track things like player fails, eliminations, and other player-specific events.
You can view markers sent with a specific player by navigating to the player’s profile in the Gamebeast user management dashboard.
Global markers
Global markers are used to track global interactions and events that are not tied to a specific player. These markers can be used to track things like game starts, game ends, and other global events.
Default markers
Gamebeast automatically sends a number of built-in markers to track generic player interactions, such as player joins, leaves, and chats. These markers are sent without any additional configuration and can be viewed in the Gamebeast dashboard.
Login
Triggered when a player logs in to your experience.
This does not include when joining from a teleport within the same experience, such as teleporting to the main place from the lobby place.
Arguments
policyInfo
{[string] : any}
the policy information of the player retrieved from PolicyService:GetPolicyInfoForPlayerAsync()
Logout
Triggered when a player leaves your experience. This does not include leaving by teleports to places within the same experience.
Arguments
sessionLength
number
The length of the player’s session in seconds across all places in the experience.
sessionLengthPercentageWithFriends
number
A 0-1 representation of the percentage of the player’s session spent with friends.
JoinedUser
Triggered when a player joins another player in your experience.
Arguments
userId
number
The ID of the user that the player joined.
isFriend
boolean
Whether the user that the player joined is a friend.
PlaceTeleport
Triggered when a player teleports to a different place within your experience.
Arguments
sourcePlaceId
number
The ID of the place the player is teleporting from.
destinationPlaceId
number
The ID of the place the player is teleporting to.
sessionLength
number
The length of the player’s session in seconds within that place.
Purchase
Triggered when a player makes a purchase in your experience, such as buying a developer product, game pass, asset, or subscription.
Arguments
type
string
The type of purchase made by the player. This can be set to gamepass, asset, devproduct or subscription.
fromReceipt
boolean
Whether or not this purchase marker was made from the receipt of a purchase via MarkersService:SendNewPurchaseGrantedMarker()
id
number
The Roblox provided identifier for the purchased item.
price
number
The price of the purchased item. This is the price the player paid, which may differ from the base price if discounts are applied from Roblox’s geographic pricing.
basePrice
number
The default price of the purchased item.
name
string
The name of the purchased item.
description
string
The description of the purchased item.
imageId
string
The image URL of the purchased item.
Chat
Triggered when a player sends a chat message in your experience.
Arguments
message
string
The chat message sent by the player.
Marker Quota
Only custom markers you define through the SDK will count towards your marker quota. Gamebeast automatically sends a number of default markers to track generic player interactions, such as player joins, leaves, and chats, but these do not count towards your quota.
While there is no hard rate limits on how often you can send markers, Gamebeast has a quota system in place to prevent abuse. If you exceed your quota, markers will be dropped until your quota resets, or you increase your quota through the project’s billing page.
It’s important to be mindful of how many markers you are sending to Gamebeast to avoid hitting your quota. You can view a usage graph of your markers in the Gamebeast dashboard to help you understand how close you are to your quota.