Custom Outcome Metadata

Learn how to log custom outcome metadata to analyze user behavior and optimize monetization performance.

What is outcome metadata?

Outcome Metadata lets you attach additional details to a logged outcome, providing context about user behavior after an upsell offer is shown. For example, you can track whether a user clicked to learn more before making a purchase or interacted with other UI elements. ContextSDK records this information alongside the outcome, offering deeper insights into user behavior and monetization performance.

How do Outcome Metadata differ from Custom Signals and Revenue Outcomes?

Custom Signals provide additional context to the machine learning model at the time of context capture, allowing them to influence decision-making. In contrast, outcome metadata is recorded after a context has been captured and does not affect the decision-making process.

Revenue Outcomes are a specialized type of metadata that have dedicated APIs due to their importance. Use revenue outcomes to log details about in-app purchases, which will automatically include the product purchased, revenue, recurrence model, and other relevant metadata, without any extra effort.

Why log outcome metadata?

Outcome metadata helps provide a deeper understanding of user behavior. It can also indicate whether your app overrode the ML model’s decision — for example, due to an upsell offer cooldown mechanism. By capturing this data, you can improve reporting accuracy and ensure the necessary data is available to refine and enhance future models.

While metadata enriches outcome tracking, it does not influence when an upsell offer is shown. If you need to factor in additional signals for determining whether to display an offer, consider using Custom Signals instead.

How to log outcome metadata

Use appendOutcomeMetadata(_:) to attach metadata to a context before logging an outcome. The metadata will only be recorded if an outcome is logged.

iOS

context.appendOutcomeMetadata([
    CustomSignalString(id: "path", value: "flow_2"),
    CustomSignalBool(id: "clicked_learn_more", value: true),
])

After appending metadata, ensure that an outcome (whether positive or negative) is logged, e.g.:

context.logRevenueOutcome(from: product)

Android

Kotlin

context.outcomeMetadata["path"] = "flow_2"
context.outcomeMetadata["clicked_learn_more"] = true

After appending metadata, ensure that an outcome (whether positive or negative) is logged, e.g.:

context.log(EventOutcome.POSITIVE)

Java

context.getOutcomeMetadata().set("path", "flow_2");
context.getOutcomeMetadata().set("clicked_learn_more", true);

After appending metadata, ensure that an outcome (whether positive or negative) is logged, e.g.:

context.log(EventOutcome.POSITIVE);

Flutter

context.appendOutcomeMetadata({
  'path': 'flow_2',
  'clicked_learn_more': true,
});

After appending metadata, ensure that an outcome (whether positive or negative) is logged, e.g.:

await context.log(Outcome.positive);

Unity

context.AppendOutcomeMetadata("path", "flow_2");
context.AppendOutcomeMetadata("clicked_learn_more", true);

After appending metadata, ensure that an outcome (whether positive or negative) is logged, e.g.:

context.Log(Outcome.Positive);

React Native

await context.appendOutcomeMetadata({
    path: 'flow_2',
    clicked_learn_more: true,
});

After appending metadata, ensure that an outcome (whether positive or negative) is logged, e.g.:

await context.log(Outcome.positive);

Appending metadata with the same ID multiple times replaces the previous value. This ensures only the most recent data is retained. To remove a value, pass nil.