Android

references/android.mdMarkdown22 KBView on GitHub

Android - Docs

It uses an internal queue to make calls fast and non-blocking. It also batches requests and flushes asynchronously, making it perfect to use in any part of your mobile app.

Installation

Android · Omnibus Instrument Product Analytics · PostHog/skills · Skills Docs

import android.app.Application
import com.posthog.android.PostHogAndroid
import com.posthog.android.PostHogAndroidConfig
class SampleApp : Application() {
    companion object {
        const val POSTHOG_API_KEY = "<ph_project_token>"
        // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
        const val POSTHOG_HOST = "https://us.i.posthog.com"
    }
    override fun onCreate() {
        super.onCreate()
        val config = PostHogAndroidConfig(
            apiKey = POSTHOG_API_KEY,
            host = POSTHOG_HOST
        )
        PostHogAndroid.setup(this, config)
    }
}

import com.posthog.PostHog
PostHog.identify(
    distinctId = distinctID,
    userProperties = mapOf(
        "name" to "Max Hedgehog",
        "email" to "max@hedgehogmail.com"
    ),
    userPropertiesSetOnce = mapOf(
        "date_of_first_log_in" to "2024-03-01"
    ),
)

import com.posthog.PostHog
PostHog.capture(
    event = "button_b_clicked",
    properties = mapOf("color" to "blue"),
    userProperties = mapOf(
        "string" to "value1",
        "integer" to 2
    )
)

import com.posthog.PostHog
PostHog.capture(
    event = "button_b_clicked",
    properties = mapOf("color" to "blue"),
    userPropertiesSetOnce = mapOf(
        "string" to "value1",
        "integer" to 2
    )
)

import com.posthog.PostHog
if (PostHog.isFeatureEnabled("flag-key")) {
    // Do something differently for this user
    // Optional: fetch the payload
    val matchedFlagPayload = PostHog.getFeatureFlagPayload("flag-key")
}

import com.posthog.PostHog
if (PostHog.getFeatureFlag("flag-key") == "variant-key") { // replace 'variant-key' with the key of your variant
    // Do something differently for this user
    // Optional: fetch the payload
    val matchedFlagPayload = PostHog.getFeatureFlagPayload("flag-key")
}

import com.posthog.PostHog
import com.posthog.android.PostHogAndroidConfig
import com.posthog.PostHogOnFeatureFlags
// During SDK initialization
val config = PostHogAndroidConfig(apiKey = "<ph_project_token>").apply {
    onFeatureFlags = PostHogOnFeatureFlags {
        if (PostHog.isFeatureEnabled("flag-key")) {
            // do something
        }
    }
}
// And/Or manually the SDK is initialized
PostHog.reloadFeatureFlags {
    if (PostHog.isFeatureEnabled("flag-key")) {
        // do something
    }
}

val config = PostHogAndroidConfig(apiKey = POSTHOG_API_KEY, host = POSTHOG_HOST).apply {
    // Capture certain application events automatically. (on/true by default)
    captureApplicationLifecycleEvents = true
    // Capture screen views automatically. (on/true by default)
    captureScreenViews = true // (on/true by default)
    // Capture deep links as part of the screen call. (on/true by default)
    captureDeepLinks = true
    // Maximum number of events to keep in queue before flushing (20 by default)
    flushAt = 20
    // Number of maximum events in memory and disk, when the maximum is exceed, the oldest event is deleted and the new one takes place. (1000 by default)
    maxQueueSize = 1000
    // Number of maximum events in a batch call. (50 by default)
    maxBatchSize = 50
    // Maximum delay before flushing the queue (30 seconds)
    flushIntervalSeconds = 30
    // Logs the SDK messages into Logcat. (off/false by default)
    debug = false
    // Prevents capturing any data if enabled. (off/false by default)
    optOut = false
    // Send a '$feature_flag_called' event when a feature flag is used automatically. (on/true by default)
    sendFeatureFlagEvent = true
    // Preload feature flags automatically. (on/true by default)
    preloadFeatureFlags = true
    // Evaluation context tags that constrain which feature flags are evaluated. (not set by default)
    // When set, only flags with matching evaluation context tags (or no evaluation context tags) will be returned.
    // Available in version 3.25.0+. The legacy parameter `evaluationEnvironments` (version 3.24.0+) is also supported.
    evaluationContexts = listOf("production", "android", "mobile")
    // Callback that is called when feature flags are loaded (not set by default)
    onFeatureFlags = { ... }
    // Callback that allows to sanitize the event properties (not set by default)
    propertiesSanitizer = { properties -> ... }
    // Hook for encrypt and decrypt events
    // Devices are sandbox already
    // Defaults to no encryption
    encryption = object : PostHogEncryption { ... }
    // Hook that allows for modification of the default mechanism for
    // generating anonymous id (which as of now is just random UUID v7)
    getAnonymousId = { ... }
    // Determines the behavior for processing user profiles.
    // Defaults to PersonProfiles.IDENTIFIED_ONLY
    personProfiles = PersonProfiles.IDENTIFIED_ONLY
    // Enable Recording of Session Replay. (off/false by default)
    sessionReplay = false
    // Session Replay configuration
    // https://posthog.com/docs/session-replay/installation for more details
    sessionReplayConfig = PostHogSessionReplayConfig(...)
    // Whether the SDK should reuse the anonymous Id between user changes.
    // When enabled, a single Id will be used for all anonymous users on this device (off/false by default)
    reuseAnonymousId = false
    // Error tracking configuration
    errorTrackingConfig = PostHogErrorTrackingConfig(...)
}