Track API in Kotlin SDK Alpha

Learn about the track API call in Kotlin SDK.

  •   2 minute read  

This guide explains how to use the track API in Kotlin SDK.

Overview

The Kotlin SDK provides a track API that lets you record the user’s actions along with any properties associated with them.

Method definition

The track method definition is as follows:

analytics.track(
    name = "Product Added",
    properties = buildJsonObject {
        put("key", "value")
    },
    options = RudderOption()
)

// Track event with event name
analytics.track(name = "Product Added")

// Track event with event name and properties
analytics.track(
    name = "Product Added",
    properties = buildJsonObject {
        put("key-1", "value-1")
    },
)

// Track event with event name and options
analytics.track(
    name = "Product Added",
    options = RudderOption(
        customContext = buildJsonObject {
            put("key-1", "value-1")
        },
        integrations = buildJsonObject {
            put("Amplitude", true)
            put("INTERCOM", buildJsonObject {
                put("lookup", "phone")
            })
        },
        externalIds = listOf(
            ExternalId(type = "brazeExternalId", id = "value1234"),
        ),
    ),
)

The below table describes the track method signature in detail:

FieldData typeDescription
nameStringName of the event.
propertiesPropertiesAdditional properties describing the event that you want to send.
optionsRudderOptionAdditional event options.

A sample track event sent from the Kotlin SDK is shown below:

analytics.track(
    name = "Product Added",
    options = RudderOption(
        customContext = buildJsonObject {
            put("currency", "USD")
        },
        integrations = buildJsonObject {
            put("Amplitude", true)
            put("INTERCOM", buildJsonObject {
                put("lookup", "phone")
            })
        },
        externalIds = listOf(
            ExternalId(type = "brazeExternalId", id = "1hKOmRA4GRlm"),
        ),
    ),
)

Questions? Contact us by email or on Slack