Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
AnalyticsService
Inherits from: Instance → Object
AnalyticsService is a collection of methods that allows you to track how users interact with your experiences, specifically player progression, in-experience economy, funnels, and custom events. For more information on using this service, see Event types.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, Service, NotReplicated
Properties
| Name | Type / Returns | Description |
|---|---|---|
| AnalyticsService.ApiKey | string | PlayFab API key. Must be set in order to use FireEvent. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
AnalyticsService.ApiKey
Deprecated. This property is deprecated. Do not use it for new work.
This property contains the game's PlayFab API key. It must be set and valid in order to use FireEvent.
| Field | Value |
|---|---|
| type | string |
| tags | ["Deprecated"] |
| security | {"read":"LocalUserSecurity","write":"LocalUserSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| AnalyticsService:FireCustomEvent | () | Fires a custom event with a custom event name and data. |
| AnalyticsService:FireEvent | () | Report a custom event to PlayFab. |
| AnalyticsService:FireInGameEconomyEvent | () | Fire an event used to track player actions pertaining to the in-game |
| AnalyticsService:FireLogEvent | () | Fire a log event used to track errors and warnings experienced by players. |
| AnalyticsService:FirePlayerProgressionEvent | () | Fire an event used to track player progression through the game. |
| AnalyticsService:GetPlayerSegmentsAsync | Dictionary | Returns coarse player segment buckets for the current experience. |
| AnalyticsService:LogCustomEvent | () | Logs an event used to track custom metrics of a user in experience. |
| AnalyticsService:LogEconomyEvent | () | Logs an event used to track player actions related in experience. |
| AnalyticsService:LogFunnelStepEvent | () | Logs an event used to track user actions stepping through a pre-planned funnel. |
| AnalyticsService:LogJourneyEvent | () | Logs a journey event used to track non-linear player paths through an experience. |
| AnalyticsService:LogOnboardingFunnelStepEvent | () | Logs an event used to track user actions stepping through an onboarding funnel. |
| AnalyticsService:LogProgressionCompleteEvent | () | Logs an event for when a user has completed a level attempt. |
| AnalyticsService:LogProgressionEvent | () | Logs an event for when a user has started, completed, or failed a level attempt. |
| AnalyticsService:LogProgressionFailEvent | () | Logs an event for when a user has failed a level attempt. |
| AnalyticsService:LogProgressionStartEvent | () | Logs an event for when a user has started a level attempt. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
AnalyticsService:FireCustomEvent
Deprecated. This deprecated function is a variant of AnalyticsService:LogCustomEvent() which should be used instead.
This function triggers a custom event with a custom event name data.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Instance | The player who triggered the custom event. nil if not player related. | |
| eventCategory | string | User defined category. This should be the name of the event. | |
| customData | Variant | Optional. User defined data, could be a string, a number or a table. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (analytics-event---custom).
AnalyticsService:FireEvent
Deprecated. This function has been deprecated in favor of more descriptive methods, including AnalyticsService:LogCustomEvent(), AnalyticsService:LogEconomyEvent(), and AnalyticsService:LogProgressionEvent().
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| category | string | 'The category of event to report. Cannot contain the following characters: comma ,, double quote " or newline characters \r\n'. | |
| value | Variant | A value to be serialized and reported. Serialized length must not exceed 1 KiB, or 1024 bytes. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
AnalyticsService:FireInGameEconomyEvent
Deprecated. This deprecated function is a variant of AnalyticsService:LogEconomyEvent() which should be used instead.
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Instance | The player who triggered the economy event. | |
| itemName | string | The name of the item. | |
| economyAction | AnalyticsEconomyAction | Indicates the acquisition or spending of an in game resource. | |
| itemCategory | string | A user defined category for items such as "Vehicle," "Weapon.". | |
| amount | int | The amount of the currency. | |
| currency | string | The currency used. Examples: 'gold', 'gems', 'life.'. | |
| location | Variant | The event location. A dictionary that each key-value represents an entry of location data. The key-value is a string-string pair. With this you can query which are the most popular "stores" then maybe you want to increase/lower the price for the stores. See the example below: lua local location = { ["placeDesc"] = "Dungeon1", ["levelDesc"] = "level2", ["mapDesc"] = "LeftChamberMap", ["storeName"] = "DarkSmith", ["userDefinedKey"] = "0005" } | |
| customData | Variant | Optional. User defined data, could be a string, a number or a table. |
Returns
| Type | Description |
|---|---|
| () | No return. |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (analytics-event---economy).
AnalyticsService:FireLogEvent
Deprecated. This method is deprecated. Do not use it for new work.
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Instance | The player who triggered the error event, nil if not player related. | |
| logLevel | AnalyticsLogLevel | The specified log level (e.g. Debug, Error). | |
| message | string | User defined message. | |
| debugInfo | Variant | Optional. A dictionary which contains predefined keys including "errorCode" and "stackTrace". Both keys values are strings. stackTrace is a traceback of the current function call stack. | |
| customData | Variant | Optional. User defined data, could be a string, a number or a table. |
Returns
| Type | Description |
|---|---|
| () | No return. |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (analytics-event---log).
AnalyticsService:FirePlayerProgressionEvent
Deprecated. This deprecated function is a variant of AnalyticsService:LogProgressionEvent() which should be used instead.
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Instance | The player who triggered the event. | |
| category | string | A user defined category for progression. | |
| progressionStatus | AnalyticsProgressionStatus | Indicates the status of the progression. | |
| location | Variant | The event location. A dictionary that each key-value represents an entry of location data. The key-value is a string-string pair. With this developers can query where is the most frequent location for a specific progression event category. For example, the category could be "LevelUp". | |
| statistics | Variant | Optional. A dictionary that each key-value represents an entry of statistics data that allows developers to track any specific data that they want to collect as players progress through their game. Key-Value is a string-number pair. | |
| customData | Variant | Optional. User defined data, could be a string, a number or a table. |
Returns
| Type | Description |
|---|---|
| () | No return. |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (analytics-event---progression).
AnalyticsService:GetPlayerSegmentsAsync
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:
| Name | Type | Description |
|---|---|---|
HasData | bool | Whether segment data was successfully retrieved for the player. |
ActivePayerStatus | Enum.ActivePayerStatus | The player's current payer status bucket for this experience. |
WhenUserFirstPlayed | Enum.WhenUserFirstPlayed | When the player first played this experience, represented as a bucket. |
PlatformSpenderStatus | Enum.PlayerPlatformSpenderStatus | The player's platform-wide spender status bucket, including whether the player falls outside the active spender bucket. |
ExperienceActivationStatus | Enum.ExperienceActivationStatus | Whether the player is new, active, lapsed, or reactivated in this experience, based on the last 30 days. |
EngagementLevel | Enum.EngagementLevel | How many days the player played this experience in the last 7 days, represented as a bucket. |
PlatformActivationStatus | Enum.PlayerPlatformActivationStatus | Whether the player is new, active, lapsed, or reactivated on Roblox, based on the last 60 days. |
UserNewReturningStatus | Enum.UserNewReturningStatus | Whether the player is new to this experience or has played it before. |
UserAcquisitionSource | Enum.UserAcquisitionSource | How the player first found this experience. |
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The player whose segment buckets should be returned. |
Returns
| Type | Description |
|---|---|
| Dictionary | A dictionary containing coarse player segment buckets for the current experience. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (AnalyticsService-GetPlayerSegmentsAsync).
AnalyticsService:LogCustomEvent
Logs an event used to track custom metrics of a user in experience. For more information, see Custom events.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The user who triggered the event. | |
| eventName | string | The name of the custom event. | |
| value | double | 1 | The value of the event that will be used in aggregation. |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (Log-Custom-Event).
AnalyticsService:LogEconomyEvent
Logs an event used to track player actions related in experience. For more information, see Economy events.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The user who triggered the event. | |
| flowType | AnalyticsEconomyFlowType | Should specify the direction that currency is flowing using AnalyticsEconomyFlowType. | |
| currencyType | string | The name of the currency being added or removed, for example "gold", "gems", or "energy". Limited to 5 unique currency types per experience. | |
| amount | float | The amount of currency being added or removed. This value should always be positive. | |
| endingBalance | float | The user's balance after the currency has been added or removed. This value should always be greater than or equal to 0. | |
| transactionType | string | The type of transaction that occurred. While you're free to use any transaction type, it's recommended to use the provided types from AnalyticsEconomyTransactionType such as "IAP" or "ContextualPurchase" to enable future insights from Roblox tools and charts. Because this field type is a string, you'll need to pass the Name value of the enum. For example Enum.AnalyticsEconomyTransactionType.IAP.Name. Limited to 20 unique types per experience. | |
| itemSku | string | Optional SKU of the item or bundle being purchased. This is a unique identifier for the item being purchased. Limited to 100 unique SKUs per experience. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (AnalyticsService-LogEconomyEvent-IAP).
AnalyticsService:LogFunnelStepEvent
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The user who triggered the event. | |
| funnelName | string | The name of the funnel. This should be the same for all steps in the funnel. Limited to 10 unique funnels per experience. | |
| funnelSessionId | string | Optional unique identifier for the funnel session. This should be the same for all steps in the funnel. Note that this field is only necessary for recurring funnels, for example a purchase flow funnel or an item upgrade funnel. If you don't have a natural funnel session identifier, it's recommended to use HttpService:GenerateGUID(). | |
| step | int | 1 | The step number in the funnel. This should be unique for each step in the funnel. All funnels start at step 1. Limited to steps 1-100. Repeated steps by the same user in the same funnel session, or when funnelSessionId is nil will be ignored. Note that if any steps are skipped, the intermediate steps will be considered completed. |
| stepName | string | Optional name of the step in the funnel. This field is only used for display purposes in Roblox-provided charts. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (AnalyticsService-LogFunnelStepEvent-Shop).
AnalyticsService:LogJourneyEvent
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The player who triggered the journey event. | |
| journeyName | string | The name of the journey. This should be the same for all nodes in the journey. Cannot be empty and cannot contain a comma ,, double quote ", single quote ', or newline character. | |
| nodeName | string | The name of the node the player reached in the journey. Cannot be empty, cannot contain a comma ,, double quote ", single quote ', or newline character, and cannot start with __ (double underscore), which is reserved. | |
| journeySessionId | string | Optional unique identifier for the journey session. This should be the same for all nodes in a single session of the journey. If provided, cannot contain a comma ,, double quote ", single quote ', or newline character. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
AnalyticsService:LogOnboardingFunnelStepEvent
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The user who triggered the event. | |
| step | int | The step number in the funnel. This should be unique for each step in the funnel. All funnels start at step 1. Limited to steps 1-100. Note that if any steps are skipped, the intermediate steps will be considered completed. | |
| stepName | string | Optional name of the step in the funnel. This field is only used for display purposes in Roblox-provided charts. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (AnalyticsService-LogOnboardingFunnelStepEvent-TwoSteps).
AnalyticsService:LogProgressionCompleteEvent
Logs an event for when a user has completed a level attempt. This event does not currently display in any Roblox-provided charts.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The player who triggered the event. | |
| progressionPathName | string | The name of the progression path this event belongs to, such as a world, chapter, or level group. This groups related progression events together. Cannot be empty and cannot contain a comma ,, double quote ", single quote ', or newline character. | |
| level | int | The numeric level the player is progressing through within the progression path. | |
| levelName | string | The name of the level associated with this event. This field is used for display purposes in Roblox-provided charts. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
AnalyticsService:LogProgressionEvent
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The player who triggered the event. | |
| progressionPathName | string | The name of the progression path this event belongs to, such as a world, chapter, or level group. This groups related progression events together. Cannot be empty and cannot contain a comma ,, double quote ", single quote ', or newline character. | |
| status | AnalyticsProgressionType | The progression status to record, provided as an AnalyticsProgressionType value such as Start, Complete, or Fail. The AnalyticsService:LogProgressionStartEvent(), AnalyticsService:LogProgressionCompleteEvent(), and AnalyticsService:LogProgressionFailEvent() methods are shortcuts that set this status for you. | |
| level | int | The numeric level the player is progressing through within the progression path. | |
| levelName | string | The name of the level associated with this event. This field is used for display purposes in Roblox-provided charts. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
AnalyticsService:LogProgressionFailEvent
Logs an event for when a user has failed a level attempt. This event does not currently display in any Roblox-provided charts.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The user who triggered the event. | |
| progressionPathName | string | The name of the progression path this event belongs to, such as a world, chapter, or level group. This groups related progression events together. Cannot be empty and cannot contain a comma ,, double quote ", single quote ', or newline character. | |
| level | int | The numeric level the player is progressing through within the progression path. | |
| levelName | string | The name of the level associated with this event. This field is used for display purposes in Roblox-provided charts. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
AnalyticsService:LogProgressionStartEvent
Logs an event for when a user has started a level attempt. This event does not currently display in any Roblox-provided charts.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The player who triggered the event. | |
| progressionPathName | string | The name of the progression path this event belongs to, such as a world, chapter, or level group. This groups related progression events together. Cannot be empty and cannot contain a comma ,, double quote ", single quote ', or newline character. | |
| level | int | The numeric level the player is progressing through within the progression path. | |
| levelName | string | The name of the level associated with this event. This field is used for display purposes in Roblox-provided charts. | |
| customFields | Dictionary | nil | Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |