Tracking Link

    An Airbridge tracking link is an all-in-one link that serves as both a linking tool to redirect users and a tracking tool for attribution.

    When they are clicked on, tracking links enable users to reach their desired destination in the app regardless of the platform, channel, or device operating system. It also helps to analyze and attribute the source of user conversions such as link click, post-click install, and post-install purchase.

    Attention


    POST

    https://api.airbridge.io/v1/tracking-links

    Request to create Tracking Link.

    channel
    Requiredstring

    Channel name of the touchpoint and conversion.

    Upon creation, tracking links are separated into "integrated" channels and "custom" channels.

    "Integrated" channels are medias with postback integration, and have predefined channel names. All other channel names are considered "Custom" channels.

    campaignParams
    object

    Configure campaign parameter for tracking link.

    campaignParams.campaign
    string

    The campaign credited with the winning touchpoint or conversion.

    campaignParams.ad_group
    string

    The ad group credited with the winning touchpoint or conversion.

    campaignParams.ad_creative
    string

    The ad creative credited with the winning touchpoint or conversion.

    campaignParams.content
    string

    The content credited with the winning touchpoint or conversion.

    campaignParams.term
    string

    The search term credited with the winning touchpoint or conversion.

    campaignParams.sub_id
    string

    The sub publisher that generated the touchpoint.
    Sub media values are usually provided by predefined "integrated" channels.

    campaignParams.sub_id_1
    string

    The 1st level sub-sub publisher that generated the touchpoint.
    Sub media values are usually provided by predefined "integrated" channels.

    campaignParams.sub_id_2
    string

    The 2nd level sub-sub publisher that generated the touchpoint.
    Sub media values are usually provided by predefined "integrated" channels.

    campaignParams.sub_id_3
    string

    The 3rd level sub-sub publisher that generated the touchpoint.
    Sub media values are usually provided by predefined "integrated" channels.

    isReengagement
    enum

    Configure the Re-engagement parameter. The Re-engagement parameter has three options: OFF, ON-TRUE, and ON-FALSE.

    ENUM VALUES
    OFF

    OFF is the default setting. The touchpoint can be attributed to both install events and post-install events (in-app events).

    ON-TRUE

    ON-TRUE is used for re-engagement campaigns for installed users. The touchpoint generated by the tracking link is attributed only to the deeplink open and the following in-app events, not to the install event.

    ON-FALSE

    ON-FALSE is used for user acquisition campaigns targeting uninstalled users. The touchpoint generated by the tracking link is attributed only to the install event and the following in-app events, not to the 'deeplink open' event.

    deeplinkUrl
    stringnullable

    Configure the Deeplink URL for redirect.

    If deeplinkUrl is missing or null, the deeplink setting is not configured.

    fallbackPaths
    object

    Configure the redirect path by platform when deep linking doesn't redirect as intended.

    fallbackPaths.android
    enum

    Redirect android user to google-play, airpage or http(s) url

    ENUM VALUES
    google-play

    Landing in the Google Play Store.

    airpage

    Landing in the Airpage.

    {http_url}

    Landing in the URL.

    fallbackPaths.ios
    enum

    Redirect iOS user to itunes-appstore, airpage or http(s) url

    ENUM VALUES
    itunes-appstore

    Landing in the App Store.

    airpage

    Landing in the Airpage.

    {http_url}

    Landing in the URL.

    fallbackPaths.desktop
    enum

    Redirect desktop user to google-play, itunes-appstore or http(s) url

    ENUM VALUES
    google-play

    Landing in the Google Play Store.

    itunes-appstore

    Landing in the App Store.

    {http_url}

    Landing in the URL.

    fallbackPaths.option
    object
    fallbackPaths.option.iosCustomProductPageId
    string

    The ppid for the Custom Product Page in the Apple App Store.

    Enable the custom product page to be shown when landing in the App Store.

    fallbackPaths.option.googlePlayCustomStoreListing
    string

    The Custom Store Listing listing value for the Google Play Store.

    Enables the display of your custom store listing when landing on the Google Play Store.

    ogTag
    object

    Configure the Open Graph for the tracking link that will be shown when the link is shared or posted.

    ogTag.websiteCrawl
    enum

    The Open Graph of url specified in fallbackPath.

    ENUM VALUES
    desktop

    It can be used to maintain the URL's Open Graph. If this parameter is present, the values of title, description, and imageUrl are ignored.

    ogTag.title
    string

    og:title for tracking link

    ogTag.description
    string

    og:description for tracking link

    ogTag.imageUrl
    string

    og:image for tracking link

    customShortId
    string

    Configure the short ID of tracking links depending on your campaign or contents.
    If not passed, a random short ID will be generate, and can not be changed once generated.

    200 SUCCESS

    Tracking Link was successfully created.

     Parameter

    Description

    trackingLink.id

    The ID of Tracking Link.

    trackingLink.channelType

    The channel type of Tracking Link.

    trackingLink.link.impression

    The Tracking Link generate impression event

    trackingLink.link.click

    The Tracking Link generate click event.

    trackingLink.link.serverToServerClick

    The Tracking Link generate S2S event.

    trackingLink.shortId

    The short ID of Tracking Link.

    trackingLink.shortURL

    The short link of Tracking Link.

    trackingLink.trackingTemplateID

    The template ID of Tracking Link.

    404 ERROR

    There is no such app. Please check the request token again.

    422 ERROR

    There are some invalid values in request.


    GET

    https://api.airbridge.io/v1/tracking-links/{id}

    Get the details of a tracking link.

    id
    Requiredstring

    The ID of the Tracking Link.

    200 SUCCESS

    404 ERROR

    There is an error in the field provided, or there is no such resource.

    422 ERROR

    A field is missing or has an error.


    PATCH

    https://api.airbridge.io/v1/tracking-links/{id}/og-tag

    Update the Open Graph of the tracking link.

    id
    string

    The ID of the Tracking Link.

    title
    Requiredstring

    og:title of the tracking link

    description
    Requiredstring

    og.description of the tracking link

    imageUrl
    Requiredstring

    og:image of the tracking link

    200 SUCCESS

    404 ERROR

    There is an error in the field provided, or there is no such resource.


    PATCH

    https://api.airbridge.io/v1/tracking-links/{id}/routing

    Update the destination and fallback path for the Tracking Link.

    id
    Requiredstring

    The ID of the tracking link.

    deeplinkUrl
    Requiredstringnullable

    The Deeplink URL to redirect.

    If deeplinkUrl is missing or null, the deeplink setting is not configured.

    fallbackPaths
    object

    Redirect paths when a deep link fails by platform.

    fallbackPaths.android
    Requiredenum

    The path to which Android will be redirected. This can be a URL in the form of google-play, airpage, or HTTP(S).

    ENUM VALUES
    google-play

    Landing in the Google Play Store.

    airpage

    Landing in the Airpage.

    {HTTP_URL}

    Landing in the URL.

    fallbackPaths.ios
    Requiredenum

    The path to be redirected on iOS. Can be a URL in the form of itunes-appstore, airpage, or HTTP(S)

    ENUM VALUES
    itunes-appstore

    Landing in the App Store.

    airpage

    Landing in the Airpage.

    {HTTP_URL}

    Landing in the URL.

    fallbackPaths.desktop
    Requiredenum

    The path to be redirected from the desktop. This can be a URL in the form of google-play, itunes-appstore, or HTTP(S).

    ENUM VALUES
    google-play

    Landing in the Google Play Store.

    itunes-appstore

    Landing in the App Store.

    {HTTP_URL}

    Landing in the URL.

    option
    object

    Set option of fallback.

    option.iosCustomProductPageId
    string

    The ppid from the Custom Product Page in the Apple App Store.

    option.googlePlayCustomStoreListing
    string

    The Custom Store Listing listing value for the Google Play Store.

    200 SUCCESS

    404 ERROR

    There is an error in the field provided, or there is no such resource.


    GET

    https://api.airbridge.io/v1/tracking-links

    Get a list of the Tracking Links.

    from
    Requiredstring

    The start date for tracking link list query.

    to
    Requiredstring

    The end date for tracking list query.

    skip
    integer

    The number of items to skip.

    size
    integer

    The number of items to retrieve.

    Note that up to 500 can be set.

    keyword
    string

    The keyword to search for.

    channel_name
    string

    Filter channel.

    sort_key
    enum

    Sort standard. The default is createdAt

    ENUM VALUES
    createdAt

    Sort by created at.

    sort_type
    enum

    Sort by.

    ENUM VALUES
    DESC

    Descending.

    ASC

    Ascending.

    200 SUCCESS

    400 ERROR

    The field contains an error or is incorrectly formatted.

    Was this page helpful?

    Have any questions or suggestions?