AnalyticsService On DevHub

Summary

This class is a service. It is a singleton that may be acquired with GetService.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Memory Category	Instances

Tags: [Service, Deprecated]

Inherits (1)

Instance

Member index (6)

Type	Member	History
string	ApiKey	391 438
null	FireCustomEvent (Instance player, string eventCategory, Variant customData)	457 573
null	FireEvent (string category, Variant value)	391 438 573
null	FireInGameEconomyEvent (Instance player, string itemName, AnalyticsEconomyAction economyAction, string itemCategory, int amount, string currency, Variant location, Variant customData)	457 573
null	FireLogEvent (Instance player, AnalyticsLogLevel logLevel, string message, Variant debugInfo, Variant customData)	457 573
null	FirePlayerProgressionEvent (Instance player, string category, AnalyticsProgressionStatus progressionStatus, Variant location, Variant statistics, Variant customData)	457 573
57 members inherited from Instance

Removed member index (13)

Type	Member	History
string	GetClientId ()	364 386
string	GetSessionId ()	364 386
void	ReleaseRBXEventStream (string target)	335 386
void	ReportCounter (string counterName, int amount = 1)	269 386
void	ReportInfluxSeries (string seriesName, Dictionary points, int throttlingPercentage)	310 386
void	ReportStats (string category, float value)	269 386
void	SendEventDeferred (string target, string eventContext, string eventName, Dictionary additionalArgs)	348 386
void	SendEventImmediately (string target, string eventContext, string eventName, Dictionary additionalArgs)	348 386
void	SetRBXEvent (string target, string eventContext, string eventName, Dictionary additionalArgs)	269 386
void	SetRBXEventStream (string target, string eventContext, string eventName, Dictionary additionalArgs)	276 386
void	TrackEvent (string category, string action, string label, int64 value = 0)	291 325 386
void	TrackEventWithArgs (string category, string action, string label, Dictionary args, int64 value = 0)	377 386
void	UpdateHeartbeatObject (Dictionary args)	270 386

573 Change ReturnType of AnalyticsService.FireCustomEvent from void to null
573 Change ReturnType of AnalyticsService.FireEvent from void to null
573 Change ReturnType of AnalyticsService.FireInGameEconomyEvent from void to null
573 Change ReturnType of AnalyticsService.FireLogEvent from void to null
573 Change ReturnType of AnalyticsService.FirePlayerProgressionEvent from void to null
549 Change Tags of AnalyticsService from [Service] to [Service, Deprecated]
457 Change Tags of AnalyticsService from [NotCreatable, Service] to [Service]
457 Add AnalyticsService.FireCustomEvent
457 Add AnalyticsService.FireInGameEconomyEvent
457 Add AnalyticsService.FireLogEvent
457 Add AnalyticsService.FirePlayerProgressionEvent
438 Change Tags of AnalyticsService.ApiKey from [] to [Deprecated]
438 Change Tags of AnalyticsService.FireEvent from [] to [Deprecated]
397 Change Tags of AnalyticsService from [NotCreatable, Service, NotReplicated] to [NotCreatable, Service]
391 Add AnalyticsService
386 Remove AnalyticsService
377 Add AnalyticsService.TrackEventWithArgs
364 Add AnalyticsService.GetClientId
364 Add AnalyticsService.GetSessionId
348 Add AnalyticsService.SendEventDeferred
348 Add AnalyticsService.SendEventImmediately
335 Add AnalyticsService.ReleaseRBXEventStream
325 Change Parameters of AnalyticsService.TrackEvent from (string category, string action, string label) to (string category, string action, string label, int64 value = 0)
310 Add AnalyticsService.ReportInfluxSeries
291 Add AnalyticsService.TrackEvent
276 Add AnalyticsService.SetRBXEventStream
270 Add AnalyticsService.UpdateHeartbeatObject
269 Add AnalyticsService.ReportCounter
269 Add AnalyticsService.ReportStats
269 Change Parameters of AnalyticsService.SetRBXEvent from (string eventContext, string eventName, Dictionary additionalArgs) to (string target, string eventContext, string eventName, Dictionary additionalArgs)
268 Add AnalyticsService

Members

ApiKey On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	string
Security	LocalUserSecurity
Category	Data
Can Load	true
Can Save	true

History

438 Change Tags of AnalyticsService.ApiKey from [] to [Deprecated]
391 Add AnalyticsService

Tags: [Deprecated]

FireCustomEvent On DevHub

Parameters	3

Name	Type	Default
player	Instance	none
eventCategory	string	none
customData	Variant	none

Return Type	null

History

573 Change ReturnType of AnalyticsService.FireCustomEvent from void to null
457 Add AnalyticsService.FireCustomEvent

FireEvent On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
category	string	none
value	Variant	none

Return Type	null

History

573 Change ReturnType of AnalyticsService.FireEvent from void to null
438 Change Tags of AnalyticsService.FireEvent from [] to [Deprecated]
391 Add AnalyticsService

Tags: [Deprecated]

FireInGameEconomyEvent On DevHub

Parameters	8

Name	Type	Default
player	Instance	none
itemName	string	none
economyAction	AnalyticsEconomyAction	none
itemCategory	string	none
amount	int	none
currency	string	none
location	Variant	none
customData	Variant	none

Return Type	null

History

573 Change ReturnType of AnalyticsService.FireInGameEconomyEvent from void to null
457 Add AnalyticsService.FireInGameEconomyEvent

FireLogEvent On DevHub

Parameters	5

Name	Type	Default
player	Instance	none
logLevel	AnalyticsLogLevel	none
message	string	none
debugInfo	Variant	none
customData	Variant	none

Return Type	null

History

573 Change ReturnType of AnalyticsService.FireLogEvent from void to null
457 Add AnalyticsService.FireLogEvent

FirePlayerProgressionEvent On DevHub

Parameters	6

Name	Type	Default
player	Instance	none
category	string	none
progressionStatus	AnalyticsProgressionStatus	none
location	Variant	none
statistics	Variant	none
customData	Variant	none

Return Type	null

History

573 Change ReturnType of AnalyticsService.FirePlayerProgressionEvent from void to null
457 Add AnalyticsService.FirePlayerProgressionEvent

Removed members

GetClientId

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
364 Add AnalyticsService.GetClientId

GetSessionId

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
364 Add AnalyticsService.GetSessionId

ReleaseRBXEventStream

Parameters	1

Name	Type	Default
target	string	none

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
335 Add AnalyticsService.ReleaseRBXEventStream

ReportCounter

Parameters	2

Name	Type	Default
counterName	string	none
amount	int	1

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
269 Add AnalyticsService.ReportCounter

ReportInfluxSeries

Parameters	3

Name	Type	Default
seriesName	string	none
points	Dictionary	none
throttlingPercentage	int	none

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
310 Add AnalyticsService.ReportInfluxSeries

ReportStats

Parameters	2

Name	Type	Default
category	string	none
value	float	none

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
269 Add AnalyticsService.ReportStats

SendEventDeferred

Parameters	4

Name	Type	Default
target	string	none
eventContext	string	none
eventName	string	none
additionalArgs	Dictionary	none

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
348 Add AnalyticsService.SendEventDeferred

SendEventImmediately

Parameters	4

Name	Type	Default
target	string	none
eventContext	string	none
eventName	string	none
additionalArgs	Dictionary	none

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
348 Add AnalyticsService.SendEventImmediately

SetRBXEvent

Parameters	4

Name	Type	Default
target	string	none
eventContext	string	none
eventName	string	none
additionalArgs	Dictionary	none

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
269 Change Parameters of AnalyticsService.SetRBXEvent from (string eventContext, string eventName, Dictionary additionalArgs) to (string target, string eventContext, string eventName, Dictionary additionalArgs)

SetRBXEventStream

Parameters	4

Name	Type	Default
target	string	none
eventContext	string	none
eventName	string	none
additionalArgs	Dictionary	none

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
276 Add AnalyticsService.SetRBXEventStream

TrackEvent

Parameters	4

Name	Type	Default
category	string	none
action	string	none
label	string	none
value	int64	0

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
325 Change Parameters of AnalyticsService.TrackEvent from (string category, string action, string label) to (string category, string action, string label, int64 value = 0)
291 Add AnalyticsService.TrackEvent

TrackEventWithArgs

Parameters	5

Name	Type	Default
category	string	none
action	string	none
label	string	none
args	Dictionary	none
value	int64	0

Return Type	void
Security	RobloxScriptSecurity

History

386 Remove AnalyticsService
377 Add AnalyticsService.TrackEventWithArgs

UpdateHeartbeatObject

Parameters	1

Name	Type	Default
args	Dictionary	none

Return Type	void
Security	RobloxScriptSecurity