Logging Conversions

Learn how to capture user context and log conversions to optimize upsell decisions.

Optimizing conversions begins with tracking them. In ContextDecision, this is done by capturing the user’s context and logging whether a conversion occurred.

Our SDK provides different methods for capturing context, each designed for specific use cases. This document outlines these methods and explains when to use them.

If you’re new here, refer to the instructions at Getting Started for guidance on generating your license key and installing the SDK.

Capturing Context

ContextManager.swift

static func fetchContext(
    flowName: String,
    duration: Int,
    customSignals: [CustomSignal] = [],
    callback: @escaping ((Context) -> Void)
)

ContextSDK.kt

fun fetchContext(
    flowName: String,
    durationS: Int = 3,
    customSignals: CustomSignals = CustomSignals(),
    callback: (RealWorldContext) -> Unit
)

This method allows you to capture the user context asynchronously. This is the recommended method to be used in most scenarios.

Always call this method, and other context-capturing methods, before displaying an in-app offer. This is because if the context is captured after showing the offer, not only ContextDecision can't make a decision on whether to show the offer or not (because it's already been shown), but also the user's context likely will have already changed (e.g. user was lying in bed but once they see an upsell offer they get up or leave the app).

When calling this method, you provide:

A flow name, which uniquely identifies the context being captured. Each flow should have a distinct name, even if the same flow is triggered from different parts of the app. We automatically analyze the overlap between different flows, to decide if there should be one, or more models.
- Best practice: use snake_case and group flows that lead to the same prompt using the same prefix, e.g. upsell_onboarding, upsell_first_action .
A duration, which determines how long accelerometer and gyroscope data is collected, in seconds. This value must be between 2 and 7 seconds, with a recommended default of 3 seconds.
An optional array of custom signals, which allows you to append additional contextual information relevant to your flow or app. Learn more in Custom Signals.

Once the context is ready, the callback executes asynchronously on the main thread. The execution timing depends on your app’s state:

If the app has been active and in the foreground for at least 3 seconds (or your configured duration), the callback executes instantly.
If the app was recently launched or resumed from the background, it may take up to 3 seconds (or your configured duration) for the context to be available.

Logging Outcomes

An outcome indicates whether an offer led to a conversion (e.g., a purchase, an ad click) or was dismissed. Always log at least one outcome for each captured context to help train the ML models effectively.

For in-app purchases, we require the product that was purchased to be passed as an argument to the outcome log. See Revenue Outcomes for more details.

If your offer is a paywall with a "Restore Purchases" button, see The skipped outcome.

For advanced outcome options, see Alternative Outcomes and Custom Outcome Metadata.

Decision-Making

The context object returned by fetchContext includes a shouldUpsell property, which determines whether an upsell offer should be shown. During the calibration phase, this property always returns true. Once a ML model is deployed to the flow, it starts making real-time decisions. If the model determines that it's a bad time, shouldUpsell will be false, so you can not show the paywall, and thus log skipped as the outcome.

There are exceptions, such as the Multivariate Monetization use case, where you would show an ad (not a paywall) when shouldUpsell is false. In these cases, you shouldn't log the skipped outcome, but instead log the outcome of your ad interaction.

For more details about this use case, see Multivariate Monetization.

Usage Example

To use this method, show the upsell offer inside the callback block to ensure the context is evaluated before presenting the offer. This guarantees that the decision logic runs first, preventing unnecessary offers from being shown when the conditions are not met:

MyOnboardingViewController.swift

// 1. Capture the context
ContextManager.fetchContext(flowName: "upsell_onboarding") { [weak self] context in
    // 2. Check if shouldUpsell is true
    guard context.shouldUpsell else {
        context.log(.skipped) // Log skipped when shouldUpsell is false
        return
    }
    // 3. Create the offer view controller
    let vc = MyPremiumOfferViewController()
    vc.userDidPurchase = { product in
        context.logRevenueOutcome(from: product)
    }
    vc.userDidDismiss = {
        context.log(.negative)
    }
    // 4. Show offer view controller here
    // …
}

MyOnboardingFragment.kt

// 1. Capture the context
ContextSDK.fetchContext("upsell_onboarding") { context ->
    // 2. Check if shouldUpsell is true
    if (!context.shouldUpsell) {
        context.log(EventOutcome.SKIPPED) // Log skipped when shouldUpsell is false
        return@fetchContext
    }
    // 3. Create the offer fragment
    val fragment = MyPremiumOfferFragment().apply {
        setOnUserDidPurchaseListener { product ->
            context.log(EventOutcome.POSITIVE)
        }
        setOnUserDidDismissListener {
            context.log(EventOutcome.NEGATIVE)
        }
    }
    // 4. Show offer fragment here
    // …
}

MyOnboardingFragment.java

// 1. Capture the context
ContextSDK.Companion.fetchContext("upsell_onboarding", null, null, context -> {
    // 2. Check if shouldUpsell is true
    if (!context.getShouldUpsell()) {
        context.log(EventOutcome.SKIPPED); // Log skipped when shouldUpsell is false
        return;
    }
    // 3. Create the offer fragment
    MyPremiumOfferFragment fragment = new MyPremiumOfferFragment();
    fragment.setOnUserDidPurchaseListener(product -> context.log(EventOutcome.POSITIVE));
    fragment.setOnUserDidDismissListener(() -> context.log(EventOutcome.NEGATIVE));
    // 4. Show offer fragment here
    // …
    return Unit.INSTANCE;
});

my_onboarding_screen.dart

// 1. Capture the context
_contextSdkPlugin.fetchContext("upsell_onboarding", 3).then((context) async {
  // 2. Check if shouldUpsell is true
  if (!(await context.shouldUpsell)) {
      await context.log(Outcome.skipped); // Log skipped when shouldUpsell is false
      return;
  }
  // 3. Create the offer screen
  final offerScreen = PremiumOfferScreen(
    onPurchase: (product) {
      await context.log(Outcome.positive);
    },
    onDismiss: () {
      await context.log(Outcome.negative);
    },
  );
  // 4. Show offer screen here
  // …
});

MyOnboardingScreen.cs

// 1. Capture the context
ContextSDKBinding.FetchContext("upsell_onboarding", delegate (Context context) {
    // 2. Check if shouldUpsell is true
    if (!context.shouldUpsell) {
        context.Log(Outcome.Skipped); // Log skipped when shouldUpsell is false
        return;
    }
    // 3. Create the offer screen
    var offerScreen = new PremiumOfferScreen();
    offerScreen.OnPurchase = product =>
    {
        context.Log(Outcome.Positive);
    };
    offerScreen.OnDismiss = () =>
    {
        context.Log(Outcome.Negative);
    };
    // 4. Show offer screen here
    // …
});

MyOnboardingScreen.js

import { fetchContext, Outcome } from 'react-native-context-sdk';

// 1. Capture the context
fetchContext({
  flowName: 'upsell_onboarding',
  onContextReady: async (context) => {
    // 2. Check if shouldUpsell is true
    if (!(await context.shouldUpsell())) {
        await context.log(Outcome.skipped); // Log skipped when shouldUpsell is false
        return;
    }
    // 3. Create and navigate to the offer screen
    navigation.navigate('PremiumOffer', {
      onPurchase: (product: any) => {
        context.log(Outcome.positive);
      },
      onDismiss: () => {
        context.log(Outcome.negative);
      },
    });
  },
});

If your project does not favor closure-based implementations like shown above when logging outcomes, see Retrieving an Existing Context below for an alternative approach that better fits different architectures.

Instant Context

In some scenarios, you may need to obtain a context immediately without waiting for the asynchronous callback. This is particularly useful when the flow is triggered by direct user interaction, such as tapping a button, where introducing any delay would negatively impact the user experience.

ContextManager.swift

@discardableResult static func instantContext(
    flowName: String,
    duration: Int,
    customSignals: [CustomSignal] = []
) -> Context

ContextSDK.kt

fun instantContext(
    flowName: String,
    durationS: Int = 3,
    customSignals: CustomSignals = CustomSignals()
): RealWorldContext

Unlike fetchContext, this method returns immediately with a context object. The signals captured in this context are based on data the SDK has already collected in the background.

Do not use instant context for flows that occur immediately after app launch. Since the SDK needs time to collect accelerometer and gyroscope data, an instant context created too early will not contain valid motion signals. This results in lower-quality data for model training and less accurate predictions.

Use fetchContext instead for flows that might trigger shortly after launch, as it will wait until sufficient data is collected.

Instant context is ideal for user-initiated actions like button taps that happen well after the app has been active. In these cases, the SDK has typically been running long enough to have collected the necessary data.

Usage Example

MySettingsViewController.swift

@IBAction func upgradeTapped(_ sender: UIButton) {
    // 1. Capture the context instantly (user tapped a button)
    let context = ContextManager.instantContext(flowName: "upsell_settings_upgrade")

    // 2. Check if shouldUpsell is true
    guard context.shouldUpsell else {
        context.log(.skipped)
        return
    }

    // 3. Create the offer view controller
    let vc = MyPremiumOfferViewController()
    vc.userDidPurchase = { product in
        context.logRevenueOutcome(from: product)
    }
    vc.userDidDismiss = {
        context.log(.negative)
    }

    // 4. Show offer view controller
    present(vc, animated: true)
}

MySettingsFragment.kt

upgradeButton.setOnClickListener {
    // 1. Capture the context instantly (user tapped a button)
    val context = ContextSDK.instantContext("upsell_settings_upgrade")

    // 2. Check if shouldUpsell is true
    if (!context.shouldUpsell) {
        context.log(EventOutcome.SKIPPED)
        return@setOnClickListener
    }

    // 3. Create the offer fragment
    val fragment = MyPremiumOfferFragment().apply {
        setOnUserDidPurchaseListener { product ->
            context.log(EventOutcome.POSITIVE)
        }
        setOnUserDidDismissListener {
            context.log(EventOutcome.NEGATIVE)
        }
    }

    // 4. Show offer fragment
    // ...
}

MySettingsFragment.java

upgradeButton.setOnClickListener(v -> {
    // 1. Capture the context instantly (user tapped a button)
    RealWorldContext context = ContextSDK.instantContext("upsell_settings_upgrade", 3, new CustomSignals());

    // 2. Check if shouldUpsell is true
    if (!context.getShouldUpsell()) {
        context.log(EventOutcome.SKIPPED);
        return;
    }

    // 3. Create the offer fragment
    MyPremiumOfferFragment fragment = new MyPremiumOfferFragment();
    fragment.setOnUserDidPurchaseListener(product -> context.log(EventOutcome.POSITIVE));
    fragment.setOnUserDidDismissListener(() -> context.log(EventOutcome.NEGATIVE));

    // 4. Show offer fragment
    // ...
});

MySettingsScreen.cs

public void OnUpgradeButtonClicked()
{
    // 1. Capture the context instantly (user tapped a button)
    var context = ContextSDKBinding.InstantContext("upsell_settings_upgrade");

    // 2. Check if shouldUpsell is true
    if (!context.shouldUpsell)
    {
        context.Log(Outcome.Skipped);
        return;
    }

    // 3. Create the offer screen
    var offerScreen = new PremiumOfferScreen();
    offerScreen.OnPurchase = product =>
    {
        context.Log(Outcome.Positive);
    };
    offerScreen.OnDismiss = () =>
    {
        context.Log(Outcome.Negative);
    };

    // 4. Show offer screen
    // ...
}

Retrieving an Existing Context

Not all architectures use closures for inter-view-controller communication. In such cases, you can capture the context and present the offer in one place, and log the outcome separately. Use the recentContext(flowName:) method to retrieve a previously captured context for a given flow name.

Note: This method does not capture a new context — it only retrieves an existing one. If no context has been captured for the specified flow, this method returns nil.

Usage Example

MyOnboardingViewController.swift

ContextManager.fetchContext(flowName: "upsell_onboarding") { [weak self] context in
    guard context.shouldUpsell else {
        context.log(.skipped)
        return
    }
    self?.present(MyPremiumOfferViewController(), animated: true)
}

MyPremiumOfferViewController.swift

func userDidCompletePurchase(product: Product) {
    if let context = ContextManager.recentContext(flowName: "upsell_onboarding") {
        context.logRevenueOutcome(from: product)
    } else {
        // This is an error state. Make sure the context above is created first.
    }
}

func dismissViewController() {
    if let context = ContextManager.recentContext(flowName: "upsell_onboarding") {
        context.log(.negative)
    } else {
        // This is an error state. Make sure the context above is created first.
    }
    // Dismiss your view controller here
}

MyOnboardingFragment.kt

ContextSDK.fetchContext("upsell_onboarding") { context ->
    if (!context.shouldUpsell) {
        context.log(EventOutcome.SKIPPED)
        return@fetchContext
    }
    val fragment = MyPremiumOfferFragment()
    // Show fragment here
}

MyPremiumOfferFragment.kt

fun userDidCompletePurchase(product: Product) {
    val context = ContextSDK.recentContext("upsell_onboarding")
    if (context != null) {
        context.log(EventOutcome.POSITIVE)
    } else {
        // This is an error state. Make sure the context above is created first.
    }
}

fun dismissFragment(fragment: Fragment) {
    val context = ContextSDK.recentContext("upsell_onboarding")
    if (context != null) {
        context.log(EventOutcome.NEGATIVE)
    } else {
        // This is an error state. Make sure the context above is created first.
    }
    // Dismiss the fragment here
}

MyOnboardingFragment.java

ContextSDK.Companion.fetchContext("upsell_onboarding", null, null, context -> {
    if (!context.getShouldUpsell()) {
        context.log(EventOutcome.SKIPPED);
        return;
    }
    MyPremiumOfferFragment fragment = new MyPremiumOfferFragment();
    // Show fragment here
    return Unit.INSTANCE;
});

MyPremiumOfferFragment.java

public void userDidCompletePurchase(Product product) {
    RealWorldContext context = ContextSDK.Companion.recentContext("upsell_onboarding");
    if (context != null) {
        context.log(EventOutcome.POSITIVE);
    } else {
        // This is an error state. Make sure the context above is created first.
    }
}

public void dismissFragment(Fragment fragment) {
    RealWorldContext context = ContextSDK.Companion.recentContext("upsell_onboarding");
    if (context != null) {
        context.log(EventOutcome.NEGATIVE);
    } else {
        // This is an error state. Make sure the context above is created first.
    }
    // Dismiss the fragment here
}

my_onboarding_screen.dart

_contextSdkPlugin.fetchContext("upsell_onboarding", 3).then((context) async {
  if (!(await context.shouldUpsell)) {
      await context.log(Outcome.skipped);
      return;
  }
  // Show offer screen here
  // …
});

my_premium_offer_screen.dart

void userDidCompletePurchase(Product product) async {
  final context = await _contextSdkPlugin.recentContext("upsell_onboarding");
  if (context != null) {
    await context.log(Outcome.positive);
  } else {
    // This is an error state. Make sure the context above is created first.
  }
}

void dismissView(BuildContext context) async {
  final context = await _contextSdkPlugin.recentContext("upsell_onboarding");
  if (context != null) {
    await context.log(Outcome.negative);
  } else {
    // This is an error state. Make sure the context above is created first.
  }
  // Dismiss screen here
}

MyOnboardingScreen.cs

public void UserDidCompletePurchase(Product product)
{
    var context = ContextSDKBinding.RecentContext("upsell_onboarding");
    if (context != null)
    {
        context.Log(Outcome.Positive);
    }
    else
    {
        // This is an error state. Make sure the context above is created first.
    }
}

public void DismissView()
{
    var context = ContextSDKBinding.RecentContext("upsell_onboarding");
    if (context != null)
    {
        context.Log(Outcome.Negative);
    }
    else
    {
        // This is an error state. Make sure the context above is created first.
    }

    // Dismiss screen here
}

PreviousGetting Started NextRevenue Outcomes

Last updated 7 days ago

Was this helpful?

hashtagCapturing Context

hashtagLogging Outcomes

hashtagDecision-Making

hashtagUsage Example

hashtagInstant Context

hashtagUsage Example

hashtagRetrieving an Existing Context

hashtagUsage Example

Capturing Context

Logging Outcomes

Decision-Making

Usage Example

Instant Context

Usage Example

Retrieving an Existing Context

Usage Example