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.

Create Tracking Link

POST

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

Request to create Tracking Link.

Request

Body Params

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.

Request

12345
curl -X POST 'https://api.airbridge.io/v1/tracking-links' \
  -H 'Aceept-Language: en' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"channel":"my-channel","campaignParams":{"campaign":"2022_FW_Sale_Festival","ad_group":"UA","ad_creative":"Coat_840x600"},"isReengagement":"ON-TRUE","fallbackPaths":{"option":{"iosCustomProductPageId":"5ae82ffe-1f08-428d-b352-ac1c3a22aa1e","googlePlayCustomStoreListing":"custom-store-listing"}},"ogTag":{"title":"30% Off Winter Apparel for 3 Days Only","description":"Get great deals on apparel to keep you warm this winter","imageUrl":"https://static.airbridge.io/images/2021_airbridge_og_tag.png"}}'

Payload

1234567891011121314151617181920
{
  "channel": "my-channel",
  "campaignParams": {
    "campaign": "2022_FW_Sale_Festival",
    "ad_group": "UA",
    "ad_creative": "Coat_840x600"
  },
  "isReengagement": "ON-TRUE",
  "fallbackPaths": {
    "option": {
      "iosCustomProductPageId": "5ae82ffe-1f08-428d-b352-ac1c3a22aa1e",
      "googlePlayCustomStoreListing": "custom-store-listing"
    }
  },
  "ogTag": {
    "title": "30% Off Winter Apparel for 3 Days Only",
    "description": "Get great deals on apparel to keep you warm this winter",
    "imageUrl": "https://static.airbridge.io/images/2021_airbridge_og_tag.png"
  }
}

Response

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.

Response

12345678910111213141516
{
  "data": {
    "trackingLink": {
      "id": 10000,
      "link": {
        "click": "http://abr.ge/@airbridge/my-channel?...",
        "impression": "http://abr.ge/@airbridge/my-channel?...",
        "serverToServerClick": null
      },
      "shortId": "6nwx4w",
      "shortURL": "http://abr.ge/6nwx4w",
      "channelType": "custom",
      "trackingTemplateID": "706f9839a7b50d87ab917dbb1b9fa7f3"
    }
  }
}

Get Tracking Link

GET

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

Get the details of a tracking link.

Request

Path Params

Requiredstring

The ID of the Tracking Link.

Request

1234
curl -X GET 'https://api.airbridge.io/v1/tracking-links/{id}' \
  -H 'Aceept-Language: en' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

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.

Response

123456789101112131415161718192021222324252627282930313233343536373839404142
{
  "data": {
    "link": {
      "click": "https://go.ab180.co/@ablog/my-channel?...",
      "impression": null,
      "serverToServerClick": null
    },
    "email": "contact@ab180.co",
    "ogTag": {
      "title": "AB180",
      "imageUrl": "http://static.airbridge.io/images/og_tags/50ca2e8d-07b2-4a0e-8294-f00ddb8e59ae.png",
      "description": "Discovering Metrics That Matter!"
    },
    "company": null,
    "shortId": "ri4lnp",
    "shortUrl": "https://go.ab180.co/ri4lnp",
    "createdAt": "2023-01-01T00:00:00+09:00",
    "channelName": "my-channel",
    "channelType": "custom",
    "deeplinkUrl": null,
    "fallbackPaths": {
      "ios": "itunes-appstore",
      "option": {
        "iosCustomProductPageId": null
      },
      "android": "google-play",
      "desktop": "https://airbridge.io"
    },
    "campaignParams": {
      "term": null,
      "subId": null,
      "subId1": null,
      "subId2": null,
      "subId3": null,
      "adGroup": null,
      "content": null,
      "campaign": "my-campaign",
      "adCreative": null
    },
    "isReengagement": false
  }
}

Update Tracking Link's Open Graph

PATCH

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

Update the Open Graph of the tracking link.

Request

Path Params

string

The ID of the Tracking Link.

Body Params

title

Requiredstring

og:title of the tracking link

description

Requiredstring

og.description of the tracking link

imageUrl

Requiredstring

og:image of the tracking link

Request

12345
curl -X PATCH 'https://api.airbridge.io/v1/tracking-links/{id}/og-tag' \
  -H 'Aceept-Language: en' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"title":"30% Off Winter Apparel for 3 Days Only","description":"Get great deals on apparel to keep you warm this winter","imageUrl":"https://static.airbridge.io/images/2021_airbridge_og_tag.png"}'

Payload

12345
{
  "title": "30% Off Winter Apparel for 3 Days Only",
  "description": "Get great deals on apparel to keep you warm this winter",
  "imageUrl": "https://static.airbridge.io/images/2021_airbridge_og_tag.png"
}

Response

200 SUCCESS

404 ERROR

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

Response

1
{}

Update Tracking Link's Routing

PATCH

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

Update the destination and fallback path for the Tracking Link.

Request

Path Params

Requiredstring

The ID of the tracking link.

Body Params

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.

Request

12345
curl -X PATCH 'https://api.airbridge.io/v1/tracking-links/{id}/routing' \
  -H 'Aceept-Language: en' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"fallbackPaths":{"android":"google-play","ios":"itunes-appstore","desktop":"https://airbridge.io"}}'

Payload

1234567
{
  "fallbackPaths": {
    "android": "google-play",
    "ios": "itunes-appstore",
    "desktop": "https://airbridge.io"
  }
}

Response

200 SUCCESS

404 ERROR

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

Response

1
{}

List Tracking Links

GET

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

Get a list of the Tracking Links.

Request

Query Params

from

Requiredstring

The start date for tracking link list query.

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.

Request

1234
curl -X GET 'https://api.airbridge.io/v1/tracking-links?from=2023-04-01&to=2023-04-02&sort_key=createdAt&sort_type=DESC' \
  -H 'Aceept-Language: en' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

200 SUCCESS

400 ERROR

The field contains an error or is incorrectly formatted.

Response

12345678910111213
{
  "data": {
    "totalCount": 2,
    "trackingLinks": [
      {
        "id": 10001
      },
      {
        "id": 10002
      }
    ]
  }
}

Response

123456789101112131415161718
{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "traceId": "1-00000000-00000000000",
  "instance": [
    {
      "ctx": {
        "limit_value": 500
      },
      "loc": [
        "size"
      ],
      "msg": "ensure this value is less than or equal to 500",
      "type": "value_error.number.not_le"
    }
  ]
}

Was this page helpful?