Tracking Link

Last updated March 21, 2024

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 token
It is advised to use the "Tracking link API token" when creating tracking links from the client server.

Create Tracking Link

POST

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

Try API Request

Request to create Tracking Link.

rate limit : 50 tracking link per second

Request

Headers

Accept-Language

string

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

Content-Type

string

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

Authorization

string

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

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.

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.

deeplinkOption

object

fallbackPaths

object

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

ogTag

object

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

customShortId

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.

Request

12345
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"}}'

Payload

1234567891011121314151617181920212223
{
  "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

200SUCCESS

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.

404ERROR

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

422ERROR

There are some invalid values in request.

429ERROR

rate limit exceeded

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}

Try API Request

Get the details of a tracking link.

Request

Headers

Accept-Language

string

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

Content-Type

string

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

Authorization

string

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

Path Params

Requiredstring

The ID of the Tracking Link.

Query Params

idType

string

The format of the tracking link identifier. The default setting is id

- id: The identifier of a generic tracking link. It can be obtained via the list get API.
- shortId: Short link ID. A short link is a tracking link in short link format.
- trackingTemplateId: ID of the tracking link template.

Request

1234
curl -X GET 'https://api.airbridge.io/v1/tracking-links/10000?idType=id' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

200SUCCESS

400ERROR

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

422ERROR

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

Try API Request

Update the Open Graph of the tracking link.

Request

Headers

Accept-Language

string

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

Content-Type

string

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

Authorization

string

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

Path Params

Requiredstring

The ID of the Tracking Link.

Body Params

idType

string

The format of the tracking link identifier. The default setting is id

title

Requiredstring

og.description of the tracking link

description

Requiredstring

og:image of the tracking link

imageUrl

Requiredstring

ogTag.websiteCrawl

enum

og:image for tracking link

Request

12345
curl -X PATCH 'https://api.airbridge.io/v1/tracking-links/10000/og-tag' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"idType":"id","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

123456
{
  "idType": "id",
  "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

200SUCCESS

400ERROR

The image URL used an incorrect URL type.

404ERROR

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

Response

1
{}

Response

12345678910111213141516
{
  "instance": [
    {
      "loc": [
        "imageUrl"
      ],
      "msg": "Invalid URL",
      "type": "validation_error"
    }
  ],
  "detail": "invalid_request",
  "status": 400,
  "title": "Bad Request",
  "traceId": "1-67c6a5e8-1f93748e2c8c732e71767b98",
  "type": "about:blank"
}

Update Tracking Link's Routing

PATCH

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

Try API Request

Update the destination and fallback path for the Tracking Link.

Request

Headers

Accept-Language

string

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

Content-Type

string

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

Authorization

string

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

Path Params

Requiredstring

The ID of the Tracking Link.

Body Params

idType

string

The format of the tracking link identifier. The default setting is id

deeplinkUrl

stringnullable

Configure the Deeplink URL for redirect.

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

deeplinkOption

objectnullable

fallbackPaths

object

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

Request

12345
curl -X PATCH 'https://api.airbridge.io/v1/tracking-links/10000/routing' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"idType":"id","deeplinkOption":{"showAlertForInitialDeeplinkingIssue":true}}'

Payload

123456
{
  "idType": "id",
  "deeplinkOption": {
    "showAlertForInitialDeeplinkingIssue": true
  }
}

Response

200SUCCESS

404ERROR

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

Try API Request

Get a list of the Tracking Links.

Request

Headers

Accept-Language

string

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

Content-Type

string

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

Authorization

string

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

Query Params

from

Requiredstring

The start date for tracking link list query.

Requiredstring

The end date for tracking list query.

skip

number

The number of items to skip.

size

number

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&skip=0&size=10&sort_key=createdAt&sort_type=DESC' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

200SUCCESS

400ERROR

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?

Have any questions or suggestions?

Tracking Linkself.__wrap_n!=1&&self.__wrap_b(":Ricvf9tpkvecq:",0.5)

Tracking link API token

Create Tracking Link

Request

Headers

Body Params

Response

200SUCCESS

404ERROR

422ERROR

429ERROR

Get Tracking Link

Request

Headers

Path Params

Query Params

Response

200SUCCESS

400ERROR

422ERROR

Update Tracking Link's Open Graph

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

404ERROR

Update Tracking Link's Routing

Request

Headers

Path Params

Body Params

Response

200SUCCESS

404ERROR

List Tracking Links

Request

Headers

Query Params

Response

200SUCCESS

400ERROR

Tracking Link