v1

latestOpenAPI 3.0.12026-08-062532117.6 KB

Get affiliate link(s)

Returns affiliate links for your program, each enriched with its click, referral and sale counts, the revenue it has generated, and a ready-to-share full URL for every base URL configured on your program.

Filter by id or link for one link, or by affiliateId / affiliateEmail for every link an affiliate owns. With no parameters, every link in the program is returned.

This endpoint always returns an array. A filter that matches nothing returns [].

get/links

Query parameters

idstring uuid

The affiliate link's UUID.

linkstring

The link slug, for example jane-doe.

affiliateIdstring uuid

Return every link owned by this affiliate UUID.

affiliateEmailstring email

Return every link owned by the affiliate with this email address.

Response

The matching affiliate links. Empty when nothing matched.

idstring uuid

The affiliate link ID

linkstring

The affiliate link string

createdAtstring date-time

Timestamp when the affiliate link was created

updatedAtstring date-time

Timestamp when the affiliate link was last updated

clicksinteger

Number of clicks on this affiliate link

referralsinteger

Number of referrals generated by this link

salesinteger

Number of sales generated by this link

totalRevenuenumber float

Sum of totalEarned across every sale attributed to this link