The TrackingLinks
endpoint accepts a POST
request to generate a tracking link. It has certain attributes that can be defined as query string parameters when making a request.
Attributes
Type
enum
Type
enumThe type of tracking link.
View possible enum value | |
---|---|
Regular | Creates a standard tracking link. |
Vanity | Creates a vanity tracking link. |
CustomPath
string
CustomPath
stringThe custom path in the tracking link URL after the domain, used for vanity links (e.g., https://example.sjv.io/MyVanityLink
).
AdId
integer
AdId
integerThe unique identifier for the ad associated with the tracking link.
MediaPartnerPropertyId
integer
MediaPartnerPropertyId
integerThe unique identifier of the partner's media property (e.g., website, social media, app, etc.) where the tracking link will be used.
DeepLink
URI
DeepLink
URIIf deep linking is enabled, this is the URL that the tracking link will redirect a user to.
Example request body
curl 'https://api.impact.com/Mediapartners/<AccountSID>/Programs/<ProgramId>/TrackingLinks?MediaPartnerPropertyId=1892978&DeepLink=https%3A%2F%2Fexample.com%2Fmysite%2F&Type=vanity&subId1=test&sharedId=test2 \
-X POST \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json'