AnalyticsService
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 13
Removed member index 13
History 62
- 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 13
ApiKey
| Type | Default | |
|---|---|---|
| string | ||
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 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 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 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 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 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
LogEconomyEvent
| Parameters (8) | Default | |
|---|---|---|
| player | Player | |
| flowType | AnalyticsEconomyFlowType | |
| currencyType | string | |
| amount | float | |
| endingBalance | float | |
| transactionType | string | |
| itemSku | string | |
| customFields | Dictionary | nil |
| Returns (1) | ||
| null | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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