Create a Tracking Link

post

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

The tracking link API helps you programmatically create the tracking links that were previously created on the Airbridge dashboard.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Due to security reasons, it is strongly recommended to use your "Tracking Link API Token" for this API.

API Use Cases

Below are some main use cases for the tracking link API.

Use Case	Description
Referral Links	Create a tracking link for each user/teammate and track their performance.
Sharing Links	Create tracking link for each product/content page and measure how much traffic is flowing in.
Link Bulk Generation	Programmatically generate tracking links.

Body Params

channel

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.

campaignParams

object

Configure campaign parameter for tracking link.

isReengagement

string

enum

Defaults to OFF

Configure the Re-engagement parameter. The Re-engagement parameter has three options: OFF, ON-TRUE, and ON-FALSE. 'OFF' is the default setting. The touchpoint can be attributed to both install events and post-install events (in-app events). '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' 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.

Allowed:

deeplinkUrl

string

Configure the Deeplink URL for redirect.

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 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.

Responses

API Use Cases

200200

404404

422422