Tapfiliate

Tapfiliate integration (Marketing, Data). Imported from open-connector.

API key11 toolshttps://api.tapfiliate.com/1.6

GET

tapfiliate_list_affiliates

List Tapfiliate affiliates with optional id, email, referral, and group filters.

/affiliates/

7 parameters

Param	Type	Required	Description
page	integer	optional	The 1-based Tapfiliate result page to request. Omit this field to request the f…
click_id	string	optional	A click id used to filter affiliates.
source_id	string	optional	A source id used to filter affiliates.
email	string	optional	An email address used to filter affiliates.
referral_code	string	optional	An affiliate referral code used to filter affiliates.
parent_id	string	optional	A parent affiliate id used to list child affiliates.
affiliate_group_id	string	optional	An affiliate group id used to filter affiliates.

GET

tapfiliate_get_affiliate

Retrieve a single Tapfiliate affiliate by affiliate id.

/affiliates/{affiliate_id}/

1 parameter

Param	Type	Required	Description
affiliate_id	string	required	The Tapfiliate affiliate id.

POST

tapfiliate_create_affiliate

Create a Tapfiliate affiliate with contact, company, address, and custom field data.

/affiliates/

7 parameters

Param	Type	Required	Description
firstname	string	required	The affiliate's first name.
lastname	string	required	The affiliate's last name.
email	string	required	The affiliate's email address.
password	string	optional	The password for the new affiliate account.
company	object	optional	The affiliate's company data.
address	object	optional	The affiliate's address data.
custom_fields	object	optional	Provider-defined affiliate custom fields to send to Tapfiliate.

GET

tapfiliate_list_conversions

List Tapfiliate conversions with optional program, external id, affiliate, date, and status filters.

/conversions/

8 parameters

Param	Type	Required	Description
page	integer	optional	The 1-based Tapfiliate result page to request. Omit this field to request the f…
program_id	string	optional	The program id used to filter conversions.
external_id	string	optional	The external conversion id used to filter conversions.
affiliate_id	string	optional	The affiliate id used to filter conversions.
pending	boolean	optional	Only include conversions that have pending commissions.
date_from	string	optional	The start date for conversion filtering.
date_to	string	optional	The end date for conversion filtering.
use_profile_timezone	boolean	optional	Whether Tapfiliate should use the profile time zone.

POST

tapfiliate_create_conversion

Create a Tapfiliate conversion using a documented referral, customer, click, coupon, tracking, or asset-source matcher.

/conversions/

17 parameters

Param	Type	Required	Description
override_max_cookie_time	boolean	optional	Whether to override Tapfiliate's maximum cookie time for this conversion.
referral_code	string	optional	An affiliate referral code.
tracking_id	string	optional	The tracking id retrieved from the Tapfiliate JavaScript library.
click_id	string	optional	The Tapfiliate click id used to add reporting information.
coupon	string	optional	A coupon code used to track the conversion.
currency	string	optional	The three-letter ISO currency code for the conversion.
asset_id	string	optional	The Tapfiliate asset id.
source_id	string	optional	The Tapfiliate source id.
external_id	string	optional	A unique conversion id from the caller's system.
amount	number	optional	The conversion amount.
customer_id	string	optional	The customer id from the caller's system.
commission_type	string	optional	The Tapfiliate commission type.
commissions	array	optional	Commission overrides to send to Tapfiliate.
meta_data	object	optional	Provider-defined metadata key-value pairs to send to Tapfiliate.
program_group	string	optional	The Tapfiliate program group id.
user_agent	string	optional	The client's user agent string.
ip	string	optional	The client's IP address.

GET

tapfiliate_list_commissions

List Tapfiliate commissions with optional affiliate, approval status, and paid filters.

/commissions/

4 parameters

Param	Type	Required	Description
page	integer	optional	The 1-based Tapfiliate result page to request. Omit this field to request the f…
affiliate_id	string	optional	The affiliate id used to filter commissions.
status	string	optional	The Tapfiliate commission approval status.
paid	boolean	optional	Whether to include only paid commissions.

GET

tapfiliate_list_programs

List Tapfiliate programs with an optional asset filter.

/programs/

2 parameters

Param	Type	Required	Description
page	integer	optional	The 1-based Tapfiliate result page to request. Omit this field to request the f…
asset_id	string	optional	An asset id used to filter programs.

GET

tapfiliate_list_affiliate_groups

List Tapfiliate affiliate groups.

/affiliate-groups/

1 parameter

Param	Type	Required	Description
page	integer	optional	The 1-based Tapfiliate result page to request. Omit this field to request the f…

POST

tapfiliate_create_affiliate_group

Create a Tapfiliate affiliate group.

/affiliate-groups/

1 parameter

Param	Type	Required	Description
title	string	required	The affiliate group title.

GET

tapfiliate_list_clicks

List Tapfiliate Enterprise click records with optional program, affiliate, and date filters.

/clicks/

5 parameters

Param	Type	Required	Description
page	integer	optional	The 1-based Tapfiliate result page to request. Omit this field to request the f…
program_id	string	optional	The program id used to filter clicks.
affiliate_id	string	optional	The affiliate id used to filter clicks.
date_from	string	optional	The start date for click filtering.
date_to	string	optional	The end date for click filtering.

POST

tapfiliate_create_click

Create a Tapfiliate REST-only tracking click and return its click id for later conversion creation.

/clicks/

7 parameters

Param	Type	Required	Description
referral_code	string	required	The affiliate referral code obtained from the referral URL.
source_id	string	optional	The source id used by the affiliate when present.
meta_data	object	optional	Provider-defined metadata key-value pairs to send to Tapfiliate.
referrer	string	optional	The HTTP referrer used in Tapfiliate reporting.
landing_page	string	optional	The current landing page used in Tapfiliate reporting.
user_agent	string	optional	The full client user agent string.
ip	string	optional	The client IP address.