Android

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

The best way to install the PostHog Android library is with a build system like Gradle. This ensures you can easily upgrade to the latest versions.

All you need to do is add the posthog-android module to your App's build.gradle or build.gradle.kts:

dependencies {
  implementation("com.posthog:posthog-android:3.+")
}

Configuration

The best place to initialize the client is in your Application subclass.

class SampleApp : Application() {

    companion object {
        const val POSTHOG_API_KEY = "<ph_project_api_key>"
        const val POSTHOG_HOST = "<ph_instance_address>"
    }

    override fun onCreate() {
        super.onCreate()

        val config = PostHogAndroidConfig(
            apiKey = POSTHOG_API_KEY,
            host = POSTHOG_HOST
        )
        PostHogAndroid.setup(this, config)
    }
}

Capturing events

You can send custom events using capture:

PostHog.capture(event = "user_signed_up")

Tip: We recommend using a '[object][verb]' format for your event names, where '[object]' is the entity that the behavior relates to, and '[verb]' is the behavior itself. For example, project created, user signed up, or invite sent.

Setting event properties

Optionally, you can also include additional information in the event by setting the properties value:

PostHog.capture(
    event = "user_signed_up",
    properties = mapOf(
        "login_type" to "email",
        "is_free_trial" to true
    )
)

Capturing screen views

With captureScreenViews = true, PostHog will try to record all screen changes automatically.

If you want to manually send a new screen capture event, use the screen function.

This function requires a screenTitle. You may also pass in an optional properties object.

PostHog.screen(
    screenTitle = "Dashboard",
    properties = mapOf(
        "background" to "blue",
        "hero" to "superhog"
    )
)

Identify

We highly recommend reading our section on Identifying users to better understand how to correctly use this method.

When you start tracking events with PostHog, each user gets an anonymous ID that is used to identify them in the system. In order to link this anonymous user with someone from your database, use the identify call.

Identify lets you add metadata to your users so you can easily identify who they are in PostHog, as well as do things like segment users by these properties.

An identify call requires:

• distinctId which uniquely identifies your user in your database
• userProperties with a dictionary of key:value pairs

PostHog.identify(
    distinctId = distinctID,
    // optional: set additional user properties
    userProperties = mapOf(
        "name" to "Max Hedgehog", 
        "email" to "max@hedgehogmail.com"
    )
)

The most obvious place to make this call is whenever a user signs up, or when they update their information.

When you call identify, all previously tracked anonymous events will be linked to the user.

Setting user properties via an event

To set properties on your users via an event, you can leverage the event properties userProperties and userPropertiesSetOnce.

userProperties

Example

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

Usage

When capturing an event, you can pass a property called userProperties as an event property, and specify its value to be an object with properties to be set on the user that will be associated with the user who triggered the event.

userPropertiesSetOnce

Example

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

Usage

userPropertiesSetOnce works just like userProperties, except that it will only set the property if the user doesn't already have that property set.

Flush

You can set the number of events in the configuration that should queue before flushing. Setting this to 1 will send events immediately and will use more battery. The default value for this is 20.

You can also configure the flush interval. By default we flush all events after 30 seconds, no matter how many events have been gathered.

val config = PostHogAndroidConfig(apiKey = POSTHOG_API_KEY, host = POSTHOG_HOST).apply { 
    flushAt = 20
    flushIntervalSeconds = 30
}

You can also manually flush the queue:

PostHog.flush()

Reset

To reset the user's ID and anonymous ID, call reset. Usually you would do this right after the user logs out.

PostHog.reset()

Feature Flags

PostHog's feature flags enable you to safely deploy and roll back new features.

Boolean feature flags

if (PostHog.isFeatureEnabled("flag-key") ) {
    // do something
}

Multivariate feature flags

if (PostHog.getFeatureFlag("flag-key")  == "variant-key") { // replace 'variant-key' with the key of your variant
    // do something
}

Reloading feature flags

Feature flag values are cached. If something has changed with your user and you'd like to refetch their flag values, call the reloadFeatureFlags method.

PostHog.reloadFeatureFlags()

Experiments (A/B tests)

Since experiments use feature flags, the code for running an experiment is very similar to the feature flags code:

if (PostHog.getFeatureFlag("experiment-feature-flag-key")  == "variant-name") {
    // do something
}

It's also possible to run experiments without using feature flags.

Groups

Group analytics allows you to associate the events for that person's session with a group (e.g. teams, organizations, etc.). Read the Group Analytics guide for more information.

Note: This is a paid feature and is not available on the open-source or free cloud plan. Learn more here.

• Associate the events for this session with a group

// organization is the group type, company_id_in_your_db is the group ID
PostHog.group(
    type = "company", 
    key = "company_id_in_your_db"
)

• Associate the events for this session with a group AND update the properties of that group

PostHog.group(
    type = "company", 
    key = "company_id_in_your_db",
    groupProperties = mapOf("name" to "Awesome Inc.")
)

The name is a special property which is used in the PostHog UI for the name of the Group. If you don't specify a name property, the group ID will be used instead.

All configuration options

When creating the PostHog client, there are many options you can set:

val config = PostHogAndroidConfig(apiKey = POSTHOG_API_KEY, host = POSTHOG_HOST).apply {
    // Record certain application events automatically! (on/true by default)
    captureApplicationLifecycleEvents = true

    // Record 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

    // Maximum delay before flushing the queue (30 seconds)
    flushIntervalSeconds = 30
}