With the updates of new versions and function improvement and optimization, some of previous API designs need to be updated accordingly. In this update, some previous parameters will be deprecated and replaced with new parameters. Even though we’ve set compatibility process, please update new parameters if you are still using previous parameters for Offerslook API integration. Thanks for your understanding.

1. Single pricing type will be switched to mixed pricing type for Offer. You can set both Revenue Type and Payout Type according to your needs.

Revenue Type mainly includes RPC, RPA, RPS and RPA+RPS. Amount or percentage is required after setting.

Payout Type mainly includes CPC, CPA, CPS and CPA+CPS. Amount or percentage is required after setting.

Previous pricing type will be replaced with new format. Below is the corresponding guidance.

pricing type revenue type payout type
CPC(revenue, payout) RPC(revenue) CPC(payout)
CPA(revenue, payout) RPA(revenue) CPA(payout)
CPI(revenue, payout) RPA(revenue) CPA(payout)
CPS(revenue, payout) RPS(percent_revenue) CPS(percent_payout)
Notice:pricing_type will be deprecated and replaced with revenue type and payout type.
Field Type Description
pricing_type string Deprecated pricing_type has been replaced with revenue_type and payout_type. Please review the new parameter method.
revenue_type string Specifie the method of calculating revenues for this Offer.
Allowed values:
RPC · RPA · RPS · RPA+RPS
Values of "RPC" and "RPA" indicate a flat revenue amount, which is specified in the revenue field.
Value of "RPS " indicates revenue is a percentage of sale, which is specified in the percent_revenue field.
Value of "RPA+RPS " indicates both a flat revenue amount and a percentage of sale revenue.
NOTE: Changing the offer revenue type will remove revenue, advertiser cap.
revenue string The flat rate/amount revenue. This is applicable depending on the "revenue_type " of the Offer.
Applicable only if revenue_type is “RPC”, “RPA” or “RPA+RPS”.
percent_revenue string Percentage of sale revenue for offer. Applicable only if revenue_type is “RPS” or “RPA+RPS”.
payout_type string Offer's payout type.
Allowed values:
CPC · CPA · CPS · CPA+CPS
Values of "CPC" and "CPA" indicate a flat payout amount, which is specified in the payout field.
Value of "CPS " indicates payout is a percentage of sale, which is specified in the percent_payout field.
Value of "CPA+CPS " indicates both a flat payout amount and a percentage of sale payout.
NOTE: Changing the offer payout type will remove payout, total affiliate cap, affiliiate cap, and will delete affiliate payout and volume based tiers related to this offer as well.
payout string The flat rate/amount paid for this Offer. Applicable for Offers whose "payout_type" includes a flat rate component.
Applicable only if payout_type is “CPC”, “CPA” or “CPA+CPS”.
percent_payout string Percentage of sale payout for offer. Applicable only if payout_type is “CPS” or “CPA+CPS”.
unique_click_ip_count integer Unique IP Tracking. When you set more than 0, the system will filter the part of clicks out of the allowed repetition of independent IPs.

2. Multiple-event is not available for CPC offer due to previous single pricing type. And now you can apply multiple-event to CPC offers since we’ve replaced single pricing type with mix pricing type now. You can also set different pricing type for each events according to your needs.

Note:Only Initial Event can be set up as RPC or CPC.

Newly added parameters:revenue_type, percent_revenue, payout_type, percent_payout.

Compatibility solution for historical data: replace Pricing Type as Revenue Type and Payout Type. For example:Pricing_Type=CPI will be replaced with Revenue_Type=RPA, Payout_Type=CPA。

Field Type Description
revenue_type string Event revenue type.
Allowed values:
RPC · RPA · RPS · RPA+RPS
Note:RPC is available only when event_id =1
revenue string Event revenue.
Applicable only if revenue_type is “RPC”, “RPA” or “RPA+RPS”.
percent_revenue string Event percent revenue.
Applicable only if revenue_type is “RPS” or “RPA+RPS”.
payout_type string Event payout type.
Allowed values:
CPC · CPA · CPS · CPA+CPS
Note:CPC is only available only when event_id =1
payout string Event payout.
Applicable only if payout_type is “CPC”, “CPA” or “CPA+CPS”.
percent_payout string Event percent payout.
Applicable only if payout_type is “CPS” or “CPA+CPS”.

3. Offer Payout Tiers, Affiliate Payout, Volume Based Tiers are in accordance with Payout Type and Offer Payout Type after replacing pricing type with revenue type and payout type.

4. Offer Cap, sub-resource of Offer, is divided into Advertiser Cap and Affiliate Cap. Affiliate Cap refers to Total Affiliate Cap.

Advertiser Cap and Affiliate Cap are corresponding to adv_cap_type, adv_cap_click, adv_cap_conversion, adv_cap_revenue, aff_cap_type, aff_cap_click, aff_cap_conversion, aff_cap_payout.

Previous parameter will be processed as below with compatibility mechanism.

cap_type adv_cap_type aff_cap_type
cap_click adv_cap_click aff_cap_click
cap_conversion adv_cap_conversion aff_cap_conversion
cap_budget adv_cap_revenue Aff_cap_payout

Below is new parameters and descriptions.

Field Type Description
adv_cap_type integer Cap type:
0 none
1 total_count
2 daily_count
3 revenue
adv_cap_revenue string Advertiser cap revenue limit.
adv_cap_click integer Advertiser cap click limit.
adv_cap_conversion integer Advertiser cap conversion limit.
aff_cap_type integer Cap type:
0 none
1 total_count
2 daily_count
3 payout
aff_cap_payout string Affiliate cap payout limit.
aff_cap_click integer Affiliate cap click limit.
aff_cap_conversion integer Affiliate cap conversion limit.

IMPORTANT NOTICE: if you need to set caps as private, please make sure cap_type is in accordance with aff_cap_type under offer caps. If you changed aff_cap_type category and cap_type and aff_cap_type under affiliate cap was different, historical data, affiliate cap, will change from private to share automatically.

With the switch of pricing type, affiliate payout is changed accordingly. Percent_payout will be added to affiliate_tier.

Note: when setting affiliate_tier, the payout and percent_payout of the second tier must be equal to or larger than those of the first tier. If payout of the second tier is equal to that of first tier, then percent_payout of the second tier must be larger than that of the first tier, and vice versa.

results matching ""

    No results matching ""