Tracking Links

Generate a Tracking Link

post

Creates a new tracking link for a specified media partner within a program.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

ProgramIdintegerRequired

The unique identifier for the program.

Query parameters

MediaPartnerIdintegerRequired

The unique identifier for the media partner.

Body

application/x-www-form-urlencoded

Typestring · enumOptional

The type of tracking link to create. 'Vanity' allows for a CustomPath.

Default: RegularPossible values:

CustomPathstringOptional

A custom path for a 'Vanity' link (e.g., 'MyCustomLink').

Example: summer-sale

AdIdintegerOptional

The unique ID of the ad to associate with the link. If omitted, redirects to the program's default landing page.

Example: 656565

DeepLinkstring · uriOptional

A specific URL to redirect the user to, overriding the default.

Example: https://www.acme.com/products/tennis-balls

MediaPartnerPropertyIdintegerOptional

The unique ID of the partner's media property where the link will be used.

Example: 12345

Responses

200

The tracking link was generated successfully.

application/json

TrackingURLstring · uriOptional

The generated tracking link URL.

Example: https://example.sjv.io/c/123456/98765/101010

post/Advertisers/{AccountSID}/Programs/{ProgramId}/TrackingLinks

cURL

curl -L \
  --request POST \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Programs/{ProgramId}/TrackingLinks' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'

200

The tracking link was generated successfully.

{
  "TrackingURL": "https://example.sjv.io/c/123456/98765/101010"
}