Analytics

The Analytics section of the OpenWeb Android SDK allows publishers to track user interactions and behaviors. These insights help understand audience engagement, optimize content strategy, and make data-driven decisions.

OWAnalytics Interface

The OWAnalytics interface provides methods to handle analytics events and set custom data.

Properties and Methods

• analyticAdditionalInfo: An instance of OWBIAnalyticAdditionalInfo for adding custom BI data to analytics events.
• setAnalyticsEventDelegate(delegate: AnalyticsEventDelegate): Assigns a delegate to handle analytics events.

Default Behavior

If a delegate isn't set using setAnalyticsEventDelegate, the SDK will send analytics events to the OpenWeb Data Team by default, without notifying the publisher.

Tracking Events

Overview

The SDK enables tracking of various user actions within the app through analytics events. These events can include actions like viewing a conversation, creating comments, and more.

AnalyticsEventDelegate

The AnalyticsEventDelegate interface allows publishers to customize the handling of analytics events. Implement this interface to track events in your analytics system.

Method

fun trackEvent(
    event: OWBIAnalyticEvent,
    additionalInfo: OWBIAnalyticAdditionalInfo,
    postId: OWPostId
)

Parameters:

• event: The analytic event being tracked.
• additionalInfo: Additional information related to the event.
• postId: The ID of the post associated with the event.

Example:

val analyticsDelegate = object : AnalyticsEventDelegate {
    override fun trackEvent(event: OWBIAnalyticEvent, additionalInfo: OWBIAnalyticAdditionalInfo, postId: OWPostId) {
        // Implement tracking logic here
    }
}

OpenWeb.manager.analytics.setAnalyticsEventDelegate(analyticsDelegate)

Adding Custom BI Data

Overview

Custom BI (Business Intelligence) data can be added to analytics events using the analyticAdditionalInfo property. This allows publishers to enrich event data with context-specific information.

Example:

val additionalInfo = OpenWeb.manager.analytics.analyticAdditionalInfo
additionalInfo.customBIData = mapOf(
    "userType" to "premium",
    "sessionId" to "123456"
)

OWBIAnalyticEvent Class

The OWBIAnalyticEvent class represents the analytic events tracked by the SDK. Below is a comprehensive list of available events:

Event Types