AnalyticsService
Collection of methods that allows you to track how users interact with your experiences.
This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 16
Removed member index 13
Description
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.
History 65
- 713 Add GetPlayerSegmentsAsync
- 709 Add GetDurationLoggerTimestamp
- 637 Add LogCustomEvent
- 632 Change Parameters of LogFunnelStepEvent from (player: Player, funnelName: string, funnelSessionId: string = , step: int = 0, stepName: string = , customFields: Dictionary = nil) to (player: Player, funnelName: string, funnelSessionId: string = , step: int = 1, stepName: string = , customFields: Dictionary = nil)
- 623 Change Parameters of LogEconomyEvent from (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, endingBalance: float, amount: float, transactionType: string, itemSku: string = , customFields: Dictionary = nil) to (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, amount: float, endingBalance: float, transactionType: string, itemSku: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogProgressionStartEvent from (player: Player, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, level: int, levelName: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogProgressionFailEvent from (player: Player, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, level: int, levelName: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogProgressionEvent from (player: Player, status: AnalyticsProgressionType, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, status: AnalyticsProgressionType, level: int, levelName: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogProgressionCompleteEvent from (player: Player, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, level: int, levelName: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogOnboardingFunnelStepEvent from (player: Player, step: int, customFields: Array) to (player: Player, step: int, stepName: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogFunnelStepEvent from (player: Player, funnelName: string, step: int, customFields: Array) to (player: Player, funnelName: string, funnelSessionId: string = , step: int = 0, stepName: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogEconomyEvent from (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, endingBalance: float, amount: float, transactionType: string, itemSku: string, customFields: Array) to (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, endingBalance: float, amount: float, transactionType: string, itemSku: string = , customFields: Dictionary = nil)
- 619 Add LogProgressionStartEvent
- 619 Add LogProgressionFailEvent
- 619 Add LogProgressionEvent
- 619 Add LogProgressionCompleteEvent
- 619 Add LogOnboardingFunnelStepEvent
- 619 Add LogFunnelStepEvent
- 619 Add LogEconomyEvent
- 619 Change Tags of FirePlayerProgressionEvent from [] to [Deprecated]
- 619 Change Tags of FireLogEvent from [] to [Deprecated]
- 619 Change Tags of FireInGameEconomyEvent from [] to [Deprecated]
- 619 Change Tags of FireCustomEvent from [] to [Deprecated]
- 619 Change Tags of AnalyticsService from [Service, Deprecated] to [NotCreatable, Service, NotReplicated]
- 573 Change ReturnType of FirePlayerProgressionEvent from void to null
- 573 Change ReturnType of FireLogEvent from void to null
- 573 Change ReturnType of FireInGameEconomyEvent from void to null
- 573 Change ReturnType of FireEvent from void to null
- 573 Change ReturnType of FireCustomEvent from void to null
- 549 Change Tags of AnalyticsService from [Service] to [Service, Deprecated]
- 486 Change ThreadSafety of ApiKey from ReadOnly to ReadSafe
- 462 Change ThreadSafety of FirePlayerProgressionEvent from to Unsafe
- 462 Change ThreadSafety of FireLogEvent from to Unsafe
- 462 Change ThreadSafety of FireInGameEconomyEvent from to Unsafe
- 462 Change ThreadSafety of FireEvent from to Unsafe
- 462 Change ThreadSafety of FireCustomEvent from to Unsafe
- 462 Change ThreadSafety of ApiKey from to ReadOnly
- 457 Add FirePlayerProgressionEvent
- 457 Add FireLogEvent
- 457 Add FireInGameEconomyEvent
- 457 Add FireCustomEvent
- 457 Change Tags of AnalyticsService from [NotCreatable, Service] to [Service]
- 438 Change Tags of FireEvent from [] to [Deprecated]
- 438 Change Tags of ApiKey from [] to [Deprecated]
- 397 Change Tags of AnalyticsService from [NotCreatable, Service, NotReplicated] to [NotCreatable, Service]
- 391 Add FireEvent
- 391 Add ApiKey
- 391 Add AnalyticsService
- 386 Remove AnalyticsService
- 377 Add TrackEventWithArgs
- 364 Add GetSessionId
- 364 Add GetClientId
- 348 Add SendEventImmediately
- 348 Add SendEventDeferred
- 335 Add ReleaseRBXEventStream
- 325 Change Parameters of TrackEvent from (category: string, action: string, label: string) to (category: string, action: string, label: string, value: int64 = 0)
- 310 Add ReportInfluxSeries
- 291 Add TrackEvent
- 276 Add SetRBXEventStream
- 270 Add UpdateHeartbeatObject
- 269 Change Parameters of SetRBXEvent from (eventContext: string, eventName: string, additionalArgs: Dictionary) to (target: string, eventContext: string, eventName: string, additionalArgs: Dictionary)
- 269 Add ReportStats
- 269 Add ReportCounter
- 268 Add SetRBXEvent
- 268 Add AnalyticsService
Members 16
ApiKey
| Type | Default | |
|---|---|---|
| string | ||
This property contains the game's PlayFab API key. It must be set and valid in order to use FireEvent.
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Security | LocalUserSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | true |
FireCustomEvent
| Parameters (3) | ||
|---|---|---|
| player | Instance | |
| eventCategory | string | |
| customData | Variant | |
| Returns (1) | ||
| null | ||
This function triggers a custom event with a custom event name data.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 4
- 619 Change Tags of FireCustomEvent from [] to [Deprecated]
- 573 Change ReturnType of FireCustomEvent from void to null
- 462 Change ThreadSafety of FireCustomEvent from to Unsafe
- 457 Add FireCustomEvent
FireEvent
| Parameters (2) | ||
|---|---|---|
| category | string | |
| value | Variant | |
| Returns (1) | ||
| null | ||
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 is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
FireInGameEconomyEvent
| Parameters (8) | ||
|---|---|---|
| player | Instance | |
| itemName | string | |
| economyAction | AnalyticsEconomyAction | |
| itemCategory | string | |
| amount | int | |
| currency | string | |
| location | Variant | |
| customData | Variant | |
| Returns (1) | ||
| null | ||
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.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 4
- 619 Change Tags of FireInGameEconomyEvent from [] to [Deprecated]
- 573 Change ReturnType of FireInGameEconomyEvent from void to null
- 462 Change ThreadSafety of FireInGameEconomyEvent from to Unsafe
- 457 Add FireInGameEconomyEvent
FireLogEvent
| Parameters (5) | ||
|---|---|---|
| player | Instance | |
| logLevel | AnalyticsLogLevel | |
| message | string | |
| debugInfo | Variant | |
| customData | Variant | |
| Returns (1) | ||
| null | ||
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 is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 4
- 619 Change Tags of FireLogEvent from [] to [Deprecated]
- 573 Change ReturnType of FireLogEvent from void to null
- 462 Change ThreadSafety of FireLogEvent from to Unsafe
- 457 Add FireLogEvent
FirePlayerProgressionEvent
| Parameters (6) | ||
|---|---|---|
| player | Instance | |
| category | string | |
| progressionStatus | AnalyticsProgressionStatus | |
| location | Variant | |
| statistics | Variant | |
| customData | Variant | |
| Returns (1) | ||
| null | ||
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 function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 4
- 619 Change Tags of FirePlayerProgressionEvent from [] to [Deprecated]
- 573 Change ReturnType of FirePlayerProgressionEvent from void to null
- 462 Change ThreadSafety of FirePlayerProgressionEvent from to Unsafe
- 457 Add FirePlayerProgressionEvent
GetDurationLoggerTimestamp
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
| Thread safety | Unsafe |
|---|
History 1
GetPlayerSegmentsAsync
| Parameters (1) | ||
|---|---|---|
| player | Player | |
| Returns (1) | ||
| Dictionary | ||
This server-only method returns coarse segment buckets for a player in the current experience. 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 | ActivePayerStatus | The player's current payer status bucket for this experience. |
WhenUserFirstPlayed | WhenUserFirstPlayed | When the player first played this experience, represented as a bucket. |
PlatformSpenderStatus | PlayerPlatformSpenderStatus | The player's platform-wide spender status bucket, including whether the player falls outside the active spender bucket. |
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
LogCustomEvent
| Parameters (4) | Default | |
|---|---|---|
| player | Player | |
| eventName | string | |
| value | double | 1 |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
Logs an event used to track custom metrics of a user in experience. For more information, see Custom events.
| Thread safety | Unsafe |
|---|
History 1
- 637 Add LogCustomEvent
LogEconomyEvent
| Parameters (8) | Default | |
|---|---|---|
| player | Player | |
| flowType | AnalyticsEconomyFlowType | |
| currencyType | string | |
| amount | float | |
| endingBalance | float | |
| transactionType | string | |
| itemSku | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
Logs an event used to track player actions related in experience. For more information, see Economy events.
| Thread safety | Unsafe |
|---|
History 3
- 623 Change Parameters of LogEconomyEvent from (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, endingBalance: float, amount: float, transactionType: string, itemSku: string = , customFields: Dictionary = nil) to (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, amount: float, endingBalance: float, transactionType: string, itemSku: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogEconomyEvent from (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, endingBalance: float, amount: float, transactionType: string, itemSku: string, customFields: Array) to (player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, endingBalance: float, amount: float, transactionType: string, itemSku: string = , customFields: Dictionary = nil)
- 619 Add LogEconomyEvent
LogFunnelStepEvent
| Parameters (6) | Default | |
|---|---|---|
| player | Player | |
| funnelName | string | |
| funnelSessionId | string | |
| step | int | 1 |
| stepName | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 3
- 632 Change Parameters of LogFunnelStepEvent from (player: Player, funnelName: string, funnelSessionId: string = , step: int = 0, stepName: string = , customFields: Dictionary = nil) to (player: Player, funnelName: string, funnelSessionId: string = , step: int = 1, stepName: string = , customFields: Dictionary = nil)
- 622 Change Parameters of LogFunnelStepEvent from (player: Player, funnelName: string, step: int, customFields: Array) to (player: Player, funnelName: string, funnelSessionId: string = , step: int = 0, stepName: string = , customFields: Dictionary = nil)
- 619 Add LogFunnelStepEvent
LogOnboardingFunnelStepEvent
| Parameters (4) | Default | |
|---|---|---|
| player | Player | |
| step | int | |
| stepName | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 2
- 622 Change Parameters of LogOnboardingFunnelStepEvent from (player: Player, step: int, customFields: Array) to (player: Player, step: int, stepName: string = , customFields: Dictionary = nil)
- 619 Add LogOnboardingFunnelStepEvent
LogProgressionCompleteEvent
| Parameters (5) | Default | |
|---|---|---|
| player | Player | |
| progressionPathName | string | |
| level | int | |
| levelName | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
Logs an event for when a user has completed a level attempt. This event does not currently display in any Roblox-provided charts.
| Thread safety | Unsafe |
|---|
History 2
- 622 Change Parameters of LogProgressionCompleteEvent from (player: Player, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, level: int, levelName: string = , customFields: Dictionary = nil)
- 619 Add LogProgressionCompleteEvent
LogProgressionEvent
| Parameters (6) | Default | |
|---|---|---|
| player | Player | |
| progressionPathName | string | |
| status | AnalyticsProgressionType | |
| level | int | |
| levelName | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
History 2
- 622 Change Parameters of LogProgressionEvent from (player: Player, status: AnalyticsProgressionType, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, status: AnalyticsProgressionType, level: int, levelName: string = , customFields: Dictionary = nil)
- 619 Add LogProgressionEvent
LogProgressionFailEvent
| Parameters (5) | Default | |
|---|---|---|
| player | Player | |
| progressionPathName | string | |
| level | int | |
| levelName | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
Logs an event for when a user has failed a level attempt. This event does not currently display in any Roblox-provided charts.
| Thread safety | Unsafe |
|---|
History 2
- 622 Change Parameters of LogProgressionFailEvent from (player: Player, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, level: int, levelName: string = , customFields: Dictionary = nil)
- 619 Add LogProgressionFailEvent
LogProgressionStartEvent
| Parameters (5) | Default | |
|---|---|---|
| player | Player | |
| progressionPathName | string | |
| level | int | |
| levelName | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
Logs an event for when a user has started a level attempt. This event does not currently display in any Roblox-provided charts.
| Thread safety | Unsafe |
|---|
History 2
- 622 Change Parameters of LogProgressionStartEvent from (player: Player, level: int, levelName: string, customFields: Array) to (player: Player, progressionPathName: string, level: int, levelName: string = , customFields: Dictionary = nil)
- 619 Add LogProgressionStartEvent
Removed members 13
GetClientId
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| string | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 364 Add GetClientId
GetSessionId
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| string | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 364 Add GetSessionId
ReleaseRBXEventStream
| Parameters (1) | ||
|---|---|---|
| target | string | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 335 Add ReleaseRBXEventStream
ReportCounter
| Parameters (2) | Default | |
|---|---|---|
| counterName | string | |
| amount | int | 1 |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 269 Add ReportCounter
ReportInfluxSeries
| Parameters (3) | ||
|---|---|---|
| seriesName | string | |
| points | Dictionary | |
| throttlingPercentage | int | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 310 Add ReportInfluxSeries
ReportStats
| Parameters (2) | ||
|---|---|---|
| category | string | |
| value | float | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 269 Add ReportStats
SendEventDeferred
| Parameters (4) | ||
|---|---|---|
| target | string | |
| eventContext | string | |
| eventName | string | |
| additionalArgs | Dictionary | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 348 Add SendEventDeferred
SendEventImmediately
| Parameters (4) | ||
|---|---|---|
| target | string | |
| eventContext | string | |
| eventName | string | |
| additionalArgs | Dictionary | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 348 Add SendEventImmediately
SetRBXEvent
| Parameters (4) | ||
|---|---|---|
| target | string | |
| eventContext | string | |
| eventName | string | |
| additionalArgs | Dictionary | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 3
- 386 Remove AnalyticsService
- 269 Change Parameters of SetRBXEvent from (eventContext: string, eventName: string, additionalArgs: Dictionary) to (target: string, eventContext: string, eventName: string, additionalArgs: Dictionary)
- 268 Add SetRBXEvent
SetRBXEventStream
| Parameters (4) | ||
|---|---|---|
| target | string | |
| eventContext | string | |
| eventName | string | |
| additionalArgs | Dictionary | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 276 Add SetRBXEventStream
TrackEvent
| Parameters (4) | Default | |
|---|---|---|
| category | string | |
| action | string | |
| label | string | |
| value | int64 | 0 |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 3
- 386 Remove AnalyticsService
- 325 Change Parameters of TrackEvent from (category: string, action: string, label: string) to (category: string, action: string, label: string, value: int64 = 0)
- 291 Add TrackEvent
TrackEventWithArgs
| Parameters (5) | Default | |
|---|---|---|
| category | string | |
| action | string | |
| label | string | |
| args | Dictionary | |
| value | int64 | 0 |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 377 Add TrackEventWithArgs
UpdateHeartbeatObject
| Parameters (1) | ||
|---|---|---|
| args | Dictionary | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 386 Remove AnalyticsService
- 270 Add UpdateHeartbeatObject