Tracking Links

Endpoint for generating partner tracking links for a brand's program.

Create a tracking link

post

Generates a new tracking link for the specified program. Up to 5,000 vanity links can exist on an account — exceeding that limit returns a 403 Forbidden response.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

ProgramIdstringRequired

Unique identifier for the brand program the tracking link is for.

Query parameters

Typestring · enumOptional

The type of tracking link to generate.

• Regular: System-generated short link.
• Vanity: Branded link with a custom path (requires CustomPath).

Default: RegularPossible values:

CustomPathstringOptional

Custom path that follows the tracking domain (e.g., SummerSale produces https://example.sjv.io/SummerSale). Required when Type=Vanity. If omitted on a vanity link, a random path is generated.

AdIdstringOptional

Unique identifier of an ad to deep-link into (see the Partner Ads API). If omitted, the tracking link redirects to the brand's default landing page.

DeepLinkstring · uriOptional

The exact destination URL the tracking link should redirect to after attribution. Use this to send clicks to a specific product page instead of the brand's default landing page.

MediaPartnerPropertyIdstringOptional

Unique identifier of the media property (website, social profile, or app) where the link will be used. See the Partner Media Properties API.

subId1stringOptional

Sub-affiliate identifier surfaced as a column in partner performance reports. Use to segment traffic by your own categories.

subId2stringOptional

Additional sub-affiliate identifier surfaced as a column in partner performance reports.

subId3stringOptional

Additional sub-affiliate identifier surfaced as a column in partner performance reports.

sharedIdstringOptional

Shared identifier surfaced as a column in partner performance reports.

Responses

200

OK — returns the generated tracking link.

application/json

TrackingURLstring · uriOptional

The generated tracking link. The path format is /c/{partner-id}/{ad-id}/{program-id} for regular links, or /{CustomPath} for vanity links.

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

403

Forbidden — returned when the 5,000 vanity link limit is reached or when a referenced resource (e.g., MediaPartnerPropertyId) does not exist.

application/json

post

/Mediapartners/{AccountSID}/Programs/{ProgramId}/TrackingLinks

curl

curl -L \
  --request POST \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Programs/{ProgramId}/TrackingLinks' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

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