Goal::findAll | TUNE Dev Hub

Jump to: GET Response Notes | API Call Builder

Find Goals.

= Required Parameter

Name

Type

Description

fields

Array

List of fields to return; defaults to all fieldsShow Supported Values

Any of the following values from the Goal model are supported.

Name	Description
advertiser_id	The ID of the Advertiser for the Offer this Goal belongs to
allow_multiple_conversions	Whether to allow multiple conversions for this Goal
approve_conversions	Whether conversions on this Goal require manual approval. Applicable only if the "enable_conversion_approval" Preference is enabled.
default_payout	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	A description of this Goal
display_advertiser	Whether or not to display the Advertiser to users who otherwise lack permission to view them in the application
enforce_encrypt_tracking_pixels	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.
id	ID of unique, auto-generated object for this Goal
is_end_point	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	Whether this Goal should be hidden from Affiliates and used only to track revenue
max_payout	The revenue received for this Goal
max_percent_payout	The percent revenue received for this Goal
modified	The last time this Goal was updated
name	Name of the goal
offer_id	The ID of the Offer this Goal belongs to
payout_type	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	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	Conversion tracking method to be implemented for goal
ref_id	ID of A reference object such as an external product ID, to associate with the Goal
revenue_type	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	The status of the Goal
tiered_payout	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	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	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	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 Values

filters

Filter

Array of field values to filter results byShow Filterable Fields

The following fields from the model can be filtered on.

Name	Description
advertiser_id	The ID of the Advertiser for the Offer this Goal belongs to
allow_multiple_conversions	Whether to allow multiple conversions for this Goal
approve_conversions	Whether conversions on this Goal require manual approval. Applicable only if the "enable_conversion_approval" Preference is enabled.
default_payout	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	A description of this Goal
display_advertiser	Whether or not to display the Advertiser to users who otherwise lack permission to view them in the application
enforce_encrypt_tracking_pixels	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.
id	ID of unique, auto-generated object for this Goal
is_end_point	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	Whether this Goal should be hidden from Affiliates and used only to track revenue
max_payout	The revenue received for this Goal
max_percent_payout	The percent revenue received for this Goal
modified	The last time this Goal was updated
name	Name of the goal
offer_id	The ID of the Offer this Goal belongs to
payout_type	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	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	Conversion tracking method to be implemented for goal
ref_id	ID of A reference object such as an external product ID, to associate with the Goal
revenue_type	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	The status of the Goal
tiered_payout	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	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	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	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 Filterable Fields

sort

Sort

Array of fields and directions to sort results byShow Sortable Fields

The following fields from the model can be sorted in either ascending (ASC) or descending (DESC) order.

Name	Description
Goal.advertiser_id	The ID of the Advertiser for the Offer this Goal belongs to
Goal.allow_multiple_conversions	Whether to allow multiple conversions for this Goal
Goal.approve_conversions	Whether conversions on this Goal require manual approval. Applicable only if the "enable_conversion_approval" Preference is enabled.
Goal.default_payout	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".
Goal.description	A description of this Goal
Goal.display_advertiser	Whether or not to display the Advertiser to users who otherwise lack permission to view them in the application
Goal.enforce_encrypt_tracking_pixels	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.
Goal.id	ID of unique, auto-generated object for this Goal
Goal.is_end_point	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.
Goal.is_private	Whether this Goal should be hidden from Affiliates and used only to track revenue
Goal.max_payout	The revenue received for this Goal
Goal.max_percent_payout	The percent revenue received for this Goal
Goal.modified	The last time this Goal was updated
Goal.name	Name of the goal
Goal.offer_id	The ID of the Offer this Goal belongs to
Goal.payout_type	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.
Goal.percent_payout	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".
Goal.protocol	Conversion tracking method to be implemented for goal
Goal.ref_id	ID of A reference object such as an external product ID, to associate with the Goal
Goal.revenue_type	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.
Goal.status	The status of the Goal
Goal.tiered_payout	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.
Goal.tiered_revenue	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.
Goal.use_payout_groups	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.
Goal.use_revenue_groups	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 Sortable Fields

limit

Integer

Objects per page to return; defaults to returning all found

page

Integer

Result page to return, based on limit value; defaults to 1

contain

Contain

List of related objects to return with each resultShow Supported Values

GET Response Notes

List of Goal model objects.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.