api/internal/event/engage_analytics_event library

Classes

BannerClicked

BannerEvent

BannerViewed

CarouselClicked

Carousel container tapped (non-item region).

CarouselEvent

CarouselStepClicked

CarouselStepViewed

CarouselViewed

CountdownClicked

CountdownViewed

EngageAnalyticsEvent

A first-party (Digia analytics) event, modelled 1:1 on the Engage event matrix.

GuideCompleted

GuideDismissed

Guide abandoned (rolls up step-level dismiss).

GuideEvent

GuideStepClicked

GuideStepDismissed

GuideStepViewed

GuideViewed

NudgeClicked

NudgeDismissed

NudgeEvent

NudgeViewed

PipClicked

Collapsed/full-screen SDK chrome interactions: expand, collapse, close, mute/unmute, play/pause.

PipCompleted

Completion is a serving decision, not a reporting one: a campaign with stopOn: experienceCompleted retires permanently on this event.

PipDismissed

The PiP's terminal event, and the only one that fires for every impression — which is why it, not PipCompleted, carries the interaction counters. Reporting them on completion would have described converters only, and every such row would carry expands >= 1 by construction, since the authored CTA lives inside the expanded state.

PipEvent

Picture-in-picture analytics.

PipStepClicked

Authored CTA button taps inside the expanded PiP content.

PipStepDismissed

Full screen left without the campaign ending — the user collapsed back to the small window. A showing that ends from full screen emits the terminal Digia Experience Dismissed instead, so the two never both fire for one exit.

PipStepViewed

Full screen opened. The PiP's only "step", so the pair below brackets the expanded state exactly as a guide's step events bracket one tooltip.

PipViewed

StoriesCompleted

StoriesEvent

StoriesOpened

A story is opened (ring/thumbnail tapped).

StoriesStepClicked

StoriesStepDismissed

StoriesStepViewed

StoriesViewed

SurveyClicked

Start tapped on the welcome screen, or first-answer engagement.

SurveyCompleted

SurveyDismissed

SurveyEvent

SurveyQuestionAnswered

SurveyQuestionSkipped

SurveyQuestionViewed

SurveyViewed

TriggerContext

Trigger attribution shared by every campaign's "Viewed" event.

Enums

TriggerType

How a host-app surfaced a campaign. Serialized as lower_snake_case.