Goal Model

A Goal for an Offer. Applicable only if the "enable_offer_goals" Preference is enabled. The related Offer must also have the "has_goals_enabled" field enabled. For more information, seeĀ help.tune.com/hasoffers/offer-goals/.

NameTypeDescription
advertiser_idNullable IntegerThe ID of the Advertiser for the Offer this Goal belongs to
allow_multiple_conversionsBoolean Whether to allow multiple conversions for this Goal
approve_conversionsBoolean Whether conversions on this Goal require manual approval. Applicable only if the "enable_conversion_approval" Preference is enabled.
default_payoutDecimalThe flat rate/amount paid for this Goal. The value in this field is applicable only if "payout_type" is set to "cpa_flat" or "cpa_both".
descriptionNullable String A description of this Goal
display_advertiserBoolean Whether or not to display the Advertiser to users who otherwise lack permission to view them in the application
enforce_encrypt_tracking_pixelsBoolean Whether to enforce encrypted conversion tracking. Applicable only if the "encrypt_tracking_pixels" Preference is enabled; defaults on if the "encrypt_tracking_pixels" Preference is enabled, else off.
idIntegerID of unique, auto-generated object for this Goal
This parameter is non-writable
is_end_pointBoolean Enabling this setting will close the active session when this Goal is converted. This prevents the user from further converting on the Offer unless another active session is started. Set this to enabled on the last Goal in the flow process.
is_privateBoolean Whether this Goal should be hidden from Affiliates and used only to track revenue
max_payoutDecimalThe revenue received for this Goal
max_percent_payoutNullable DecimalThe percent revenue received for this Goal
modifiedDatetimeThe last time this Goal was updated
nameString Name of the goal
offer_idIntegerThe ID of the Offer this Goal belongs to
payout_typeString Specifies the method of calculating payout for this Goal. "cpa_flat" indicates a flat amount will be paid, specified in the "default_payout" field. "cpa_percentage" indicates that a percentage of the sale will be paid, specified in the "percent_payout" field. "cpa_both" indicates that both a flat rate and a percentage of the sale will be paid.Show Supported Values
percent_payoutNullable DecimalThe percent of sale paid for this Goal. For example, a value of "25.00" would indicate a 25% payout. The value in this field is applicable only if "payout_type" is set to "cpa_percentage" or "cpa_both".
protocolString Conversion tracking method to be implemented for goalShow Supported Values
ref_idNullable String ID of A reference object such as an external product ID, to associate with the Goal
revenue_typeString Specifies the method of calculating revenue for this Goal. "cpa_flat" indicates a flat amount will be revenue, specified in the "default_payout" field. "cpa_percentage" indicates that a percentage of the sale will be revenue, specified in the "percent_payout" field. "cpa_both" indicates that both a flat rate and a percentage of the sale will be revenue.Show Supported Values
statusString The status of the GoalShow Supported Values
tiered_payoutBoolean Whether to use Affiliate Tiers for payout calculation for Affiliates for this Goal. Cannot be enabled at the same time as "use_payout_groups". For more information, see: http://support.hasoffers.com/hc/en-us/articles/202812086-Affiliate-Payout-Tiers.
tiered_revenueBoolean Whether to use Affiliate Tiers for revenue calculation for Affiliates for this Goal. Cannot be enabled at the same time as "use_revenue_groups". For more information, see: http://support.hasoffers.com/hc/en-us/articles/202812086-Affiliate-Payout-Tiers.
use_payout_groupsBoolean Whether to use Payout Groups to calculate revenue for Affiliates for this Goal. Cannot be enabled at the same time as "tiered_payout". For more information, see: http://support.hasoffers.com/hc/en-us/articles/202305336-Payout-Revenue-Groups.
use_revenue_groupsBoolean Whether to use Revenue Groups to calculate revenue for Affiliates for this Goal. Cannot be enabled at the same time as "tiered_revenue". For more information, see: http://support.hasoffers.com/hc/en-us/articles/202305336-Payout-Revenue-Groups.
Have a Question? Please contact support@tune.com for technical support.