Create Tracking Link

curl -X POST 'https://api.airbridge.io/v1/tracking-links' \
  -H 'Accept-Language: ko' \
  -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",
  "deeplinkOption": {
    "showAlertForInitialDeeplinkingIssue": 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"
  }
}'

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "Custom Short ID is only available with a custom domain",
  "status": 400,
  "traceId": "1-000000-000000000000000"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "There is no such app.",
  "status": 404,
  "traceId": "1-000000-000000000000000"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

{
  "type": "Rate limit exceeded",
  "title": null,
  "status": 429,
  "traceId": "1-6768fb4d-0833f0c4639017b1613ac244"
}

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.

Tracking link API tokenIt is advised to use the “Tracking link API token” when creating tracking links from the client server.

Request to create Tracking Link. rate limit : 50 tracking link per second

POST

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

Request

Headers

string

You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.

string

Represents the media type of the resource. Defaults to application/json.

string

The key value to use for API requests. Instructions for getting API keys are in “how to generate API Keys”.

Body Params

string

required

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.

object

Configure campaign parameter for tracking link.

Show child attributes

string

The campaign credited with the winning touchpoint or conversion.

string

The ad group credited with the winning touchpoint or conversion.

string

The ad creative credited with the winning touchpoint or conversion.

string

The content credited with the winning touchpoint or conversion.

string

The search term credited with the winning touchpoint or conversion.

string

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

string

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

string

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

string

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

enum

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

Value	Description
`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.

string

Configure the Deeplink URL for redirect.If deeplinkUrl is missing or null, the deeplink setting is not configured.Example format: URLScheme://path?key=valueIf an invalid deeplinkUrl is used, the deep link may not work properly and could result in unexpected behavior or issues.

object

Show child attributes

boolean

Stopover Pagetrue: activatefalse: deactivate

boolean

Whether to use the custom Airpage.true: Use the custom Airpage for the user’s browser language, or the default custom Airpage if there is no page for that language.false: Do not use the custom Airpage.If not passed, the app’s default custom Airpage setting is applied.

object

Configure the redirect path by platform when deep linking doesn’t redirect as intended.Only https URLs are supported when you enter a URL directly.

Show child attributes

enum

Redirect android user to google-play or an https URL

Value	Description
`google-play`	Landing in the Google Play Store.
`{https_url}`	Landing in the `https` URL.

enum

Redirect iOS user to itunes-appstore or an https URL

Value	Description
`itunes-appstore`	Landing in the App Store.
`{https_url}`	Landing in the `https` URL.

enum

Redirect desktop user to google-play, itunes-appstore or an https URL

Value	Description
`google-play`	Landing in the Google Play Store.
`itunes-appstore`	Landing in the App Store.
`{https_url}`	Landing in the `https` URL.

object

Show child attributes

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.

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.

object

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

Show child attributes

string

The Open Graph of url specified in fallbackPath.

string

og:title for tracking link

string

og:description for tracking link

enum

og:image for tracking link

Value	Description
`desktop`	When the tracking link is shared, the social media platform directly crawls the Open Graph of the desktop URL specified in fallbackPaths and uses it for the social share preview. Dynamic URLs are also supported, and any change to the Open Graph is reflected automatically from the next time the link is shared. The values set for title, description, and imageUrl will be ignored.

boolean

Enable the Social Share preview default values set in the Airbridge dashboard.Note. Other parameter values in the og tag will be ignored.

string

Configure the Short Link ID of tracking links depending on your campaign or contents. If not passed, a random Short Link ID will be generate, and can not be changed once generated.The Short Link ID of a tracking link cannot be reused even if the tracking link has been deprecated.The Short Link ID is only available for tracking links created with a custom domain.

If a primary domain is set: The tracking link is created with the primary domain even if domain is not passed.
If no primary domain is set: Pass the custom domain to use in domain as well, or a 400 error is returned.

Allowed Characters & Restrictions

Lowercase English letters: a–z
Korean characters (Hangul): 가–힣
Numbers: 0–9
Special characters: hyphen (-), underscore (_)
Maximum length: 45 characters

string

The custom domain to create the custom channel tracking link with.Enter a custom domain that has been added to the app and verified, without the scheme and path, such as link.example.com.If not passed, the primary domain is used, and if no primary domain is set, abr.ge is used.A 400 error is returned if the domain has not been added to the app or has not been verified.

boolean

If set to true, the tracking link is created with abr.ge even if a primary domain is set.The default value is false.Cannot be used with customShortId.

curl -X POST 'https://api.airbridge.io/v1/tracking-links' \
  -H 'Accept-Language: ko' \
  -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",
  "deeplinkOption": {
    "showAlertForInitialDeeplinkingIssue": 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

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.

400

The tracking link cannot be created with the requested values. Check the cause in detail of the response.

detail	Cause
`Custom Short ID is only available with a custom domain`	`customShortId` was passed, but the tracking link is created with `abr.ge`. If no primary domain is set, pass `domain` as well.
`Domain must not include scheme` `Domain must not include path`	The value passed in `domain` includes a scheme such as `https://` or a path.
`Custom domain not found for app: {domain}`	The domain passed in `domain` has not been added to the app.
`Custom domain is not certificated: {domain}`	The domain passed in `domain` has not been verified.

404

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

422

There are some invalid values in request.

429

rate limit exceeded

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "Custom Short ID is only available with a custom domain",
  "status": 400,
  "traceId": "1-000000-000000000000000"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "There is no such app.",
  "status": 404,
  "traceId": "1-000000-000000000000000"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

{
  "type": "Rate limit exceeded",
  "title": null,
  "status": 429,
  "traceId": "1-6768fb4d-0833f0c4639017b1613ac244"
}

API Reference

Tracking Link

Server-to-Server Event

Actuals Report

Revenue Report

Active Users Report

Retention Report

Raw Data

Attribution Result

Self-Serve Data Upload

SKAdNetwork Configuration API

Request

Headers

Body Params

Response

200

400

404

422

429

​Request

​Headers

​Body Params

​Response

​200

​400

​404

​422

​429

Request

Headers

Body Params

Response

200

400

404

422

429