The OneLink Developer Hub

Welcome to the OneLink developer hub. You'll find comprehensive guides and documentation to help you start working with OneLink as quickly as possible, as well as support if you get stuck. Let's jump right in!

Input parameters

The following table lists the possible parameters OneLink can pass as an input.

The input map holds two kinds of data:

  • Attribution data
  • Data defined by the marketer in the link (parameters and values)
    Parameters can be either:
    • AppsFlyer official parameters.
    • Custom parameters and values chosen by the marketer and developer.

📘

Note

  • The following table is relevant for AppsFlyer SDK 5.4.1 and above.
    • Parameters may not be present or renamed in earlier SDK versions
  • The parameters not marked as deprecated are relevant for all OneLink types:
    • Short URL
    • Long URL
    • All OS's links:
      • Android App Link
      • Universal Links
      • URL schemes (both iOS and Android)

Parameter name

Type

Description

Remarks

af_dp

String

URI scheme URL.

Fallback to App Link.
For example: afbasicapp://mainactivity

link

String

The full link that was used to perform the deep link.

Example: https://onelink-basic-app.onelink.me/H5hv?pid=Email&c=fruit_of_the_month

deep_link_value

string

The value name for the specific in-app content that users will be directed to.

pid (media source)

String

OneLink's media source, e.g. email, SMS, social media.

install_time

String

Time of the first app launch.

Deprecated
Example: 2020-05-06 13:51:19

scheme

String

The first word in the URL, that identifies the protocol to be used to access the resource on the Internet. For example: mygreatapp://mainactivity or https://killerapp.onelink.me/coolactivity/H7JK

Deprecated
Never use http or https for URI schemes

host

String

Identifies the host that holds the resource. For example: mygreatapp://mainactivity or
https://**killerapp.onelink.me**/coolactivity/H7JK

Deprecated

path

String

The specific resource in the host that the web client wants to access. For example: https://killerapp.onelink.me/coolactivity/**H7JK**

Deprecated
Not relevant for URI schemes

shortlink

String

A shortened URL, with significantly fewer characters than the original link. For example: https://killerapp.onelink.me/coolactivity/H7JK/**checkitout**

af_web_id

String

Token for People Based Attribution.

af_status

String

Deprecated

Passed only in URI scenario

af_deeplink

Boolean

Deprecated

Passed only in URI scenario

c (campaign)

String

Name of the marketing campaign.

The value set by the marketer in the AppsFlyer dashboard.

is_retargeting

Boolean

Marks the link as part of a retargeting campaign.

The value is set by the marketer.

af_ios_url

String

Fallback URL when deep linking fails on an iOS device.

Passed to Android devices as well, even when not relevant

af_android_url

String

Fallback URL when deep-linking fails on an Android device.

af_sub[1-5]

String

Optional custom parameter defined by the advertiser.

Values set by the marketer in the AppsFlyer dashboard.
Recommended for passing parameters relevant for in-app routing.

af_adset

String

Adset is an intermediate level in the hierarchy between campaign and ad.

Value set by the marketer in AppsFlyer's dashboard

af_channel

String

The media source channel through which the ads are distributed. For example: UAC_Search, UAC_Display, Instagram, Facebook Audience Network etc.

Value set by the marketer in AppsFlyer's dashboard

ad_adname

String

Ad name provided by the marketer/publisher.

Value set by the marketer in AppsFlyer's dashboard

af_cost_currency

String

3 letter currency code compliant with ISO-4217. For example, USD, ZAR, EUR
[Default]: USD

Value set by the marketer in AppsFlyer's dashboard

af_cost_value

String

Cost value in using cost currency.

Value set by the marketer in AppsFlyer's dashboard

af_click_lookback

String

Configurable number of days for the lookback click attribution period.

Value set by the marketer in AppsFlyer's dashboard

af_force_deeplink

Boolean

Force deep linking into the activity specified in af_dp value.

Relevant for iOS only.
Value is passed to Android, even when not relevant.

Updated 4 months ago


Input parameters


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.