AnalyticsService

This property contains the game's PlayFab API key. It must be set and valid in order to use FireEvent.

This function triggers a custom event with a custom event name data.

This function reports a custom event to PlayFab. The event is reported using a category and value, where the category is a string and the value can be a string or table. In order to use PlayFab, you must have a valid ApiKey set.

This function triggers an event used to track player actions pertaining to the in-game economy. For example, it should be called to track when players acquire or spend virtual items within the economy like currency.

local location = {
    ["placeDesc"] = "Dungeon1",
    ["levelDesc"] = "level2",
    ["mapDesc"] = "LeftChamberMap",
    ["storeName"] = "DarkSmith",
    ["userDefinedKey"] = "0005"
}

This function triggers an event used to track errors and warnings experienced by players. For example, it could be called to indicate when a function call fails, such as a datastore save or TeleportService:Teleport(). See the example below.

This function triggers an event used to track player progression through the game. For example, it should be called when a player starts an in-game tutorial and again that player finishes the tutorial.

This server-only method returns coarse segment buckets for a player in the current experience. Use these buckets at runtime to personalize content or gate features for specific player groups. If a cached result is not already available, the method may yield while the engine fetches the segment data. Successfully fetched results are cached per player for the lifetime of the server session.

If segment data is unavailable, this method does not throw. Instead, it returns HasData = false and all enum fields are set to Unknown.

This method throws only when called from the client or when the player argument is invalid.

The returned dictionary has the following structure:

Logs an event used to track custom metrics of a user in experience. For more information, see Custom events.

Logs an event used to track player actions related in experience. For more information, see Economy events.

Logs an event used to track user actions stepping through a pre-planned funnel. Funnel breakdowns only consider the user and event values from the first step in a funnel session. See Funnel events.

Logs a journey event used to track non-linear player paths through an experience. Unlike funnels, which track ordered sequential steps, journeys track graph-like player paths where players can move between named nodes in any order. Each call records that a player reached a specific node within a named journey. The resulting data is visualized as a Sankey diagram in Creator Hub, showing how players distribute across paths in the experience.

Logs an event used to track user actions stepping through an onboarding funnel. Funnel breakdowns only consider the user and event values from the first step in a funnel session. See Funnel events.

Logs an event for when a user has completed a level attempt. This event does not currently display in any Roblox-provided charts.

Logs an event for when a user has started, completed, or failed a level attempt. This event does not currently display in any Roblox-provided charts.

Logs an event for when a user has failed a level attempt. This event does not currently display in any Roblox-provided charts.

Logs an event for when a user has started a level attempt. This event does not currently display in any Roblox-provided charts.