Suggested Events

The PlayOps SDK ships with a small set of built-in events (gameStarted, newPlayer, …) that fire automatically. Beyond those, every game logs its own gameplay-specific events — and most games end up logging the same kinds of things.

This section is a catalog of events we recommend implementing. They give you a consistent foundation that dashboards, A/B-test analyses, and cross-game benchmarks can rely on.

Caution

These events are not built into the SDK. You define and log them yourself, following the patterns in Defining Custom Events and Logging Events. Treat the names, types, and field semantics in this section as the canonical contract — analytics tooling expects events with these exact shapes. You can add extra fields for game-specific context, but don’t rename or remove the documented ones.

Categories

Progression

Events that bracket the player’s run through the main level flow. They share LevelSessionId as the join key — generate a fresh GUID at levelStarted and reuse it on every event for that session. A retry (fresh board) is a new session with a new ID; a continue (same board, extra resources) keeps the same ID.

A session opens with levelStarted. Within a session, the player may fail and continue any number of times — each failure fires levelFailed, and each continue fires levelContinued after it. The session is closed by levelCompleted (player won), levelAbandoned (player exited mid-session), or a final levelFailed that the player does not continue from.

• levelStarted — Opens a new level session.
• levelCompleted — Closes a session — player won.
• levelFailed — Closes a session — player failed without continuing.
• levelAbandoned — Closes a session — player exited before a resolution.
• levelContinued — Mid-session — player continued after a failure.

Global state

Global state events carry context that the SDK automatically attaches to outgoing analytics events. They make it trivial to join or segment any event by these dimensions without having to repeat the values on every event.

• LevelSessionIdGlobalState — Current level session ID, for joining any event back to its session.
• UserProgressionGlobalState — User’s main-map level progression, for segmenting any event by progression.