Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Analytics > Interfaces > IAnalyticsProvider > StartSession > IAnalyticsProvider::StartSession

Light Theme

Dark Theme

IAnalyticsProvider::StartSession

Starts a session.

Windows

MacOS

Linux

References

Module	Analytics
Header	/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Include	#include "Interfaces/IAnalyticsProvider.h"

Syntax

bool StartSession
(
const TArray< FAnalyticsEventAttribute > & Attributes
)

Remarks

Starts a session. It's technically legal to send events without starting a session. The use case is for backends and dedicated servers to send events on behalf of a user without technically affecting the session length of the local player. Local players log in and start/end the session, but remote players simply call SetUserID and start sending events, which is legal and analytics providers should gracefully handle this. Repeated calls to this method will be ignored. *param Attributes attributes of the session. Arbitrary set of key/value pairs.

Returns

true if the session started successfully.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss