Reading the attribution

After configure, the SDK reports the first open and the attribution arrives a few seconds later. It is stored, so on every later launch it is available right away.

Wait for it

let attribution = await TrueOrigin.attribution()
switch attribution.status {
case .matched:   showOnboarding(for: attribution.campaign)
case .ambiguous: break   // not confident enough; never guessed
case .unmatched: break   // organic or an untracked channel
case .expired, .failed, .pending: break
@unknown default: break
}

// in a coroutine
val attribution = TrueOrigin.attribution()
when (attribution.status) {
    Attribution.Status.MATCHED -> showOnboarding(attribution.campaign)
    Attribution.Status.UNMATCHED -> {} // organic or an untracked channel
    else -> {}                         // keep an else branch: new statuses may come
}

const attribution = await TrueOrigin.attribution()
switch (attribution.status) {
  case 'matched':     showOnboarding(attribution.campaign); break
  case 'ambiguous':   break // not confident enough; never guessed
  case 'unmatched':   break // organic or an untracked channel
  case 'expired':     break
  case 'failed':      break
  case 'unsupported': break // web
}

attribution() never throws. Call it wherever you decide what a new user sees first, for example to open onboarding on the campaign’s topic.

Or get a callback

TrueOrigin.onAttribution { attribution in
    // called once, on the main queue; right away if already final
}

TrueOrigin.onAttribution { attribution ->
    // called once, on the main thread; right away if already final
}

const cancel = TrueOrigin.onAttribution((attribution) => {
  // called once; right away if already final
})

TrueOrigin.currentAttribution (Swift, Kotlin) and TrueOrigin.currentAttribution() (React Native) return the stored state without waiting, or nothing before the first report.

Status

Status	Meaning
`pending`	Not decided yet.
`matched`	The install came from one of your tracking links. `campaign` and `payload` say which.
`ambiguous`	TrueOrigin could not decide with enough confidence. It never guesses. iOS only.
`unmatched`	Organic, or a channel without a TrueOrigin link.
`expired`	The SDK stopped waiting while the result was still pending.
`failed`	The install could not be reported: no network for the whole `reportTimeout` (`reportTimeoutMillis` in Kotlin), or the SDK key was rejected.
`unsupported`	React Native on web.

New statuses may be added. In Swift, keep an @unknown default case; in Kotlin, an else branch.

How an install is matched

iOS
Android

TrueOrigin compares the install with recent taps on your app’s tracking links. When one tap clearly led to it, the install is matched; when several could have, it is ambiguous; when none did, unmatched. Tap the link on the same iPhone you install on: a tap on a computer or another phone cannot match.

Google Play decides. When your app’s Android URL is its Google Play URL, a tap on your tracking link goes to Google Play with the tap in the link’s referrer. Google Play hands that referrer to your app after the install (the install referrer), and the SDK reports it. The install is matched to exactly that tap, or it is unmatched; Android installs are never ambiguous.unmatched on Android:

The app was installed without a tap first: from a Google Play search, an ad that does not use your tracking link, or a link straight to Google Play.
The Android URL is not a Google Play URL, or not set, when the link was tapped. Only a Google Play URL carries the tap.
The app came from somewhere else: another store, an APK, Android Studio or adb. Google Play gives those no install referrer.
The tap was on another app’s link, or on a computer.

Your app’s own referrer in the Play URL stays; TrueOrigin adds to it.

What a match carries

Field
`campaign`	The name of the named link that was tapped; empty for the ad link and an unregistered path. The ad’s own campaign is in `payload.utm` and `payload.ad`.
`slug`	The link path as it was tapped: `{app}` for the ad link, `{app}/{path}` for a named link.
`attributedAt`	When TrueOrigin decided.
`payload`	The click as JSON.

Useful keys in payload:

Key
`clicked_at`	When the link was tapped (ISO 8601).
`ad_network`	`meta`, `tiktok`, `google`, `snap`, … when the install counts for that network: the ad’s URL parameters came through, or the tap on your ad link carried its click id (else its `utm_source`). Empty for a named link tapped outside an ad, even with `fbclid`.
`link`	The path of the named link that was tapped, e.g. `anna`, also when it was in an ad; empty for the ad link.
`click_ids`	Every network click id the tap carried, as it came in.
`utm`	`source`, `medium`, `campaign`, `content`, `term`.
`ad`	`campaign_id`, `adset_id`, `ad_id`, `creative_id`, `placement`, `campaign_name`, `adset_name`, `ad_name`, `site`, as far as the ad’s URL parameters filled them in.
`query`	Every parameter of the tapped link, as it came in.

let adsetId = attribution.payload?["ad"]?["adset_id"]?.stringValue

val adsetId = (attribution.payload?.get("ad") as? Map<*, *>)?.get("adset_id") as? String

const ad = attribution.payload?.ad as Record<string, string | null> | undefined
const adsetId = ad?.adset_id

Get started

SDK

Campaigns

Help

Reading the attribution

Wait for it

Or get a callback

Status

How an install is matched

What a match carries

​Wait for it

​Or get a callback

​Status

​How an install is matched

​What a match carries

Wait for it

Or get a callback

Status

How an install is matched

What a match carries