Goal::create | TUNE Dev Hub

Jump to: POST Response Notes | API Call Builder

Creates an offer goal.

= Required Parameter

Name

Type

Description

data

Object

Goal model object data propertiesShow Supported Parameters

The following parameters are supported by this object.

Name	Type	Description
advertiser_id	Nullable Integer	The ID of the Advertiser for the Offer this Goal belongs to
allow_multiple_conversions	Boolean	Whether to allow multiple conversions for this Goal
approve_conversions	Boolean	Whether conversions on this Goal require manual approval. Applicable only if the "enable_conversion_approval" Preference is enabled.
default_payout	Decimal	The 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".
description	Nullable String	A description of this Goal
display_advertiser	Boolean	Whether or not to display the Advertiser to users who otherwise lack permission to view them in the application
enforce_encrypt_tracking_pixels	Boolean	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.
is_end_point	Boolean	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_private	Boolean	Whether this Goal should be hidden from Affiliates and used only to track revenue
max_payout	Decimal	The revenue received for this Goal
max_percent_payout	Nullable Decimal	The percent revenue received for this Goal
modified	Datetime	The last time this Goal was updated
name	String	Name of the goal
offer_id	Integer	The ID of the Offer this Goal belongs to
payout_type	String	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.
percent_payout	Nullable Decimal	The 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".
protocol	String	Conversion tracking method to be implemented for goal
ref_id	Nullable String	ID of A reference object such as an external product ID, to associate with the Goal
revenue_type	String	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.
status	String	The status of the Goal
tiered_payout	Boolean	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: https://support.hasoffers.com/hc/en-us/articles/202812086-Affiliate-Payout-Tiers.
tiered_revenue	Boolean	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: https://support.hasoffers.com/hc/en-us/articles/202812086-Affiliate-Payout-Tiers.
use_payout_groups	Boolean	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: https://support.hasoffers.com/hc/en-us/articles/202305336-Payout-Revenue-Groups.
use_revenue_groups	Boolean	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: https://support.hasoffers.com/hc/en-us/articles/202305336-Payout-Revenue-Groups.

Show Supported Parameters

return_object

Boolean

If true, returns affected object; defaults to true

POST Response Notes

Returns the ID of the newly created offer goal or returns the newly created Goal model object if return_object is "true"

API Call Builder

Javascript is required to use the API Call Builder.