AnalyticsService

Not yet Class Services NotCreatable NotReplicated Service

Collection of methods that allows you to track how users interact with your experiences.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 23 modern Roblox members not implemented yet

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.

Inheritance

Object → Instance → AnalyticsService

Properties

Member	Signature	Summary
ApiKey	ApiKey: string	PlayFab API key. Must be set in order to use FireEvent.

Methods

Member	Signature	Summary
FireCustomEvent	AnalyticsService:FireCustomEvent(player: Instance, eventCategory: string, customData: Variant): null	Fires a custom event with a custom event name and data.
FireEvent	AnalyticsService:FireEvent(category: string, value: Variant): null	Report a custom event to PlayFab.
FireInGameEconomyEvent	AnalyticsService:FireInGameEconomyEvent(player: Instance, itemName: string, economyAction: AnalyticsEconomyAction, itemCategory: string, amount: int, currency: string, location: Variant, customData: Variant): null	Fire an event used to track player actions pertaining to the in-game
FireLogEvent	AnalyticsService:FireLogEvent(player: Instance, logLevel: AnalyticsLogLevel, message: string, debugInfo: Variant, customData: Variant): null	Fire a log event used to track errors and warnings experienced by players.
FirePlayerProgressionEvent	AnalyticsService:FirePlayerProgressionEvent(player: Instance, category: string, progressionStatus: AnalyticsProgressionStatus, location: Variant, statistics: Variant, customData: Variant): null	Fire an event used to track player progression through the game.
GetDurationLoggerTimestamp	AnalyticsService:GetDurationLoggerTimestamp(): int	—
GetPlayerSegmentsAsync	AnalyticsService:GetPlayerSegmentsAsync(player: Player): Dictionary	Returns coarse player segment buckets for the current experience.
LogCustomEvent	AnalyticsService:LogCustomEvent(player: Player, eventName: string, value: double = 1, customFields: Dictionary = nil): null	Logs an event used to track custom metrics of a user in experience.
LogEconomyEvent	AnalyticsService:LogEconomyEvent(player: Player, flowType: AnalyticsEconomyFlowType, currencyType: string, amount: float, endingBalance: float, transactionType: string, itemSku: string, customFields: Dictionary = nil): null	Logs an event used to track player actions related in experience.
LogFunnelStepEvent	AnalyticsService:LogFunnelStepEvent(player: Player, funnelName: string, funnelSessionId: string, step: int = 1, stepName: string, customFields: Dictionary = nil): null	Logs an event used to track user actions stepping through a pre-planned funnel.
LogJourneyEvent	AnalyticsService:LogJourneyEvent(player: Player, journeyName: string, nodeName: string, journeySessionId: string, customFields: Dictionary = nil): null	—
LogOnboardingFunnelStepEvent	AnalyticsService:LogOnboardingFunnelStepEvent(player: Player, step: int, stepName: string, customFields: Dictionary = nil): null	Logs an event used to track user actions stepping through an onboarding funnel.
LogProgressionCompleteEvent	AnalyticsService:LogProgressionCompleteEvent(player: Player, progressionPathName: string, level: int, levelName: string, customFields: Dictionary = nil): null	Logs an event for when a user has completed a level attempt.
LogProgressionEvent	AnalyticsService:LogProgressionEvent(player: Player, progressionPathName: string, status: AnalyticsProgressionType, level: int, levelName: string, customFields: Dictionary = nil): null	Logs an event for when a user has started, completed, or failed a level attempt.
LogProgressionFailEvent	AnalyticsService:LogProgressionFailEvent(player: Player, progressionPathName: string, level: int, levelName: string, customFields: Dictionary = nil): null	Logs an event for when a user has failed a level attempt.
LogProgressionStartEvent	AnalyticsService:LogProgressionStartEvent(player: Player, progressionPathName: string, level: int, levelName: string, customFields: Dictionary = nil): null	Logs an event for when a user has started a level attempt.

Roblox reference: AnalyticsService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.