Affiliate_Offer::findMyOffers

Get all offers that are either private and the affiliate is approved for and all offers that the affiliate has stats for in the last 7 days

= 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 Offer model are supported.

Name	Description
allow_direct_links	If enabled, Affiliates are allowed to link directly to the Offer website without using a tracking link. Instead the Affiliate ID is included in the direct link and Javascript code will track the click when user lands on the page. For more information, see: https://support.hasoffers.com/entries/21691503-Direct-Links
allow_website_links	If enabled, Affiliates are allowed to pull links from the Offer website and redirect their tracking links to specific pages. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202266853-Affiliate-Tracking-Links#website-links
conversion_cap	Maximum number of conversions allowed per day for this Offer. If value is set to "0" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
currency	The 3-character currency symbol for this Offer. Some Networks allow for individual Offers to use different currencies. If NULL, this Offer uses the default Network currency.
default_goal_name	If the Offer has Goals enabled (indicated by the "has_goals_enabled" field), this is the name of the default Goal; note: This field will only be present if the Network has Offer Goals enabled
default_payout	The flat rate/amount paid for this Offer. Applicable only for Offers whose "payout_type" includes a flat rate component, i.e. "cpa_flat", "cpa_both", "cpc", and "cpm".
description	A description of the Offer
dne_download_url	If a DNE (Do Not Email) List is associated with this Offer, this will contain the URL to download the list
dne_list_id	The ID of the DNE (Do Not Email) List associated with this Offer, if one exists. Present when the Offer has DNE Lists enabled, indicated by the "show_mail_list" field
dne_unsubscribe_url	If a DNE (Do Not Email) List is associated with this Offer, this field will contain a URL where email addresses can be added to the DNE List
email_instructions	Indicates whether or not there are specific criteria required for the email subject and "from" lines Affiliates must use in communications promoting the Offer
email_instructions_from	Applicable when the "email_instructions" field is set to "1". Indicates one or more acceptable "from" lines that can be used when promoting the Offer. Valid lines are separated by line breaks.
email_instructions_subject	Applicable when the "email_instructions" field is set to "1". Indicates one or more acceptable subject lines that can be used when promoting the Offer. Valid lines are separated by line breaks.
expiration_date	Expiration date for the Offer
featured	The date from which the Network has decided to make feature this Offer. If NULL or set to "0000-00-00 00:00:00" this Offer is not currently featured. Any other valid date is the begin date of the featured status.
has_goals_enabled	Indicates whether or not this Offer has Goals enabled; note: This field will only be present if the Network has Offer Goals enabled
id	ID of unique object for this Offer
is_expired	Whether or not this Offer is expired (i.e. it has a past "expiration_date").
is_pay_per_call	Not present for all API calls. Indicates whether or not this Offer supports pay-per-call conversions.
modified	Timestamp of most recent change to object
monthly_conversion_cap	Maximum number of conversions allowed per month for this Offer. If value is set to "0" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
monthly_payout_cap	Maximum payout allowed per month for this Offer. If value is set to "0.00" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
name	The Offer's name
payout_cap	Maximum payout allowed per day for this Offer. If value is set to "0.00" then there is no cap; note: Some Networks may choose to use this feature but this field not present by default.
payout_type	Specifies the method of calculating payout for this Offer. "cpa_flat", "cpm", and "cpc" indicate 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 Offer. For example, a value of "25.00" would indicate a 25% payout. Applicable only for Offers whose "payout_type" includes a percent component, i.e. "cpa_percentage" and "cpa_both".
preview_url	URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
protocol	Conversion tracking method to use for the offer.
require_approval	Whether or not Affiliates must apply to run the Offer
require_terms_and_conditions	Whether or not this Offer requires acceptance of offer terms and conditions before an Affiliate can run it. The text of the terms and conditions is in the "terms_and_conditions" field. Important: Use "enabled" and "disabled" for all inputs, including for filter options. However, values the API returns are "0" for disabled and "1" for enabled.
show_custom_variables	Whether or not custom variables can be used in tracking links. For more information, see: https://support.hasoffers.com/entries/20718333-Adding-custom-variables-to-tracking-links.
show_mail_list	Indicates that a DNE List is attached to this Offer. See the "dne_list_id" field for the ID of the list, and the "dne_download_url" and the related "dne_unsubscribe_url" fields.
status	The status of the Offer. Affiliates can only view active Offers.
terms_and_conditions	The terms and conditions Affiliates must agree to in order to run this Offer. Should be present if "require_terms_and_conditions" is set to "enabled".
use_target_rules	Whether or not this Offer has Advanced Targeting enabled. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202305356-Advanced-Targeting.

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
allow_direct_links	If enabled, Affiliates are allowed to link directly to the Offer website without using a tracking link. Instead the Affiliate ID is included in the direct link and Javascript code will track the click when user lands on the page. For more information, see: https://support.hasoffers.com/entries/21691503-Direct-Links
allow_website_links	If enabled, Affiliates are allowed to pull links from the Offer website and redirect their tracking links to specific pages. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202266853-Affiliate-Tracking-Links#website-links
conversion_cap	Maximum number of conversions allowed per day for this Offer. If value is set to "0" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
currency	The 3-character currency symbol for this Offer. Some Networks allow for individual Offers to use different currencies. If NULL, this Offer uses the default Network currency.
default_goal_name	If the Offer has Goals enabled (indicated by the "has_goals_enabled" field), this is the name of the default Goal; note: This field will only be present if the Network has Offer Goals enabled
default_payout	The flat rate/amount paid for this Offer. Applicable only for Offers whose "payout_type" includes a flat rate component, i.e. "cpa_flat", "cpa_both", "cpc", and "cpm".
description	A description of the Offer
dne_download_url	If a DNE (Do Not Email) List is associated with this Offer, this will contain the URL to download the list
dne_list_id	The ID of the DNE (Do Not Email) List associated with this Offer, if one exists. Present when the Offer has DNE Lists enabled, indicated by the "show_mail_list" field
dne_unsubscribe_url	If a DNE (Do Not Email) List is associated with this Offer, this field will contain a URL where email addresses can be added to the DNE List
email_instructions	Indicates whether or not there are specific criteria required for the email subject and "from" lines Affiliates must use in communications promoting the Offer
email_instructions_from	Applicable when the "email_instructions" field is set to "1". Indicates one or more acceptable "from" lines that can be used when promoting the Offer. Valid lines are separated by line breaks.
email_instructions_subject	Applicable when the "email_instructions" field is set to "1". Indicates one or more acceptable subject lines that can be used when promoting the Offer. Valid lines are separated by line breaks.
expiration_date	Expiration date for the Offer
featured	The date from which the Network has decided to make feature this Offer. If NULL or set to "0000-00-00 00:00:00" this Offer is not currently featured. Any other valid date is the begin date of the featured status.
has_goals_enabled	Indicates whether or not this Offer has Goals enabled; note: This field will only be present if the Network has Offer Goals enabled
id	ID of unique object for this Offer
is_expired	Whether or not this Offer is expired (i.e. it has a past "expiration_date").
is_pay_per_call	Not present for all API calls. Indicates whether or not this Offer supports pay-per-call conversions.
modified	Timestamp of most recent change to object
monthly_conversion_cap	Maximum number of conversions allowed per month for this Offer. If value is set to "0" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
monthly_payout_cap	Maximum payout allowed per month for this Offer. If value is set to "0.00" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
name	The Offer's name
payout_cap	Maximum payout allowed per day for this Offer. If value is set to "0.00" then there is no cap; note: Some Networks may choose to use this feature but this field not present by default.
payout_type	Specifies the method of calculating payout for this Offer. "cpa_flat", "cpm", and "cpc" indicate 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 Offer. For example, a value of "25.00" would indicate a 25% payout. Applicable only for Offers whose "payout_type" includes a percent component, i.e. "cpa_percentage" and "cpa_both".
preview_url	URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
protocol	Conversion tracking method to use for the offer.
require_approval	Whether or not Affiliates must apply to run the Offer
require_terms_and_conditions	Whether or not this Offer requires acceptance of offer terms and conditions before an Affiliate can run it. The text of the terms and conditions is in the "terms_and_conditions" field. Important: Use "enabled" and "disabled" for all inputs, including for filter options. However, values the API returns are "0" for disabled and "1" for enabled.
show_custom_variables	Whether or not custom variables can be used in tracking links. For more information, see: https://support.hasoffers.com/entries/20718333-Adding-custom-variables-to-tracking-links.
show_mail_list	Indicates that a DNE List is attached to this Offer. See the "dne_list_id" field for the ID of the list, and the "dne_download_url" and the related "dne_unsubscribe_url" fields.
status	The status of the Offer. Affiliates can only view active Offers.
terms_and_conditions	The terms and conditions Affiliates must agree to in order to run this Offer. Should be present if "require_terms_and_conditions" is set to "enabled".
use_target_rules	Whether or not this Offer has Advanced Targeting enabled. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202305356-Advanced-Targeting.

Show Filterable Fields

sort

Array

Array of fields and directions to sort results byShow Supported Values

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

Name	Description
allow_direct_links	If enabled, Affiliates are allowed to link directly to the Offer website without using a tracking link. Instead the Affiliate ID is included in the direct link and Javascript code will track the click when user lands on the page. For more information, see: https://support.hasoffers.com/entries/21691503-Direct-Links
allow_website_links	If enabled, Affiliates are allowed to pull links from the Offer website and redirect their tracking links to specific pages. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202266853-Affiliate-Tracking-Links#website-links
conversion_cap	Maximum number of conversions allowed per day for this Offer. If value is set to "0" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
currency	The 3-character currency symbol for this Offer. Some Networks allow for individual Offers to use different currencies. If NULL, this Offer uses the default Network currency.
default_goal_name	If the Offer has Goals enabled (indicated by the "has_goals_enabled" field), this is the name of the default Goal; note: This field will only be present if the Network has Offer Goals enabled
default_payout	The flat rate/amount paid for this Offer. Applicable only for Offers whose "payout_type" includes a flat rate component, i.e. "cpa_flat", "cpa_both", "cpc", and "cpm".
description	A description of the Offer
dne_download_url	If a DNE (Do Not Email) List is associated with this Offer, this will contain the URL to download the list
dne_list_id	The ID of the DNE (Do Not Email) List associated with this Offer, if one exists. Present when the Offer has DNE Lists enabled, indicated by the "show_mail_list" field
dne_unsubscribe_url	If a DNE (Do Not Email) List is associated with this Offer, this field will contain a URL where email addresses can be added to the DNE List
email_instructions	Indicates whether or not there are specific criteria required for the email subject and "from" lines Affiliates must use in communications promoting the Offer
email_instructions_from	Applicable when the "email_instructions" field is set to "1". Indicates one or more acceptable "from" lines that can be used when promoting the Offer. Valid lines are separated by line breaks.
email_instructions_subject	Applicable when the "email_instructions" field is set to "1". Indicates one or more acceptable subject lines that can be used when promoting the Offer. Valid lines are separated by line breaks.
expiration_date	Expiration date for the Offer
featured	The date from which the Network has decided to make feature this Offer. If NULL or set to "0000-00-00 00:00:00" this Offer is not currently featured. Any other valid date is the begin date of the featured status.
has_goals_enabled	Indicates whether or not this Offer has Goals enabled; note: This field will only be present if the Network has Offer Goals enabled
id	ID of unique object for this Offer
is_expired	Whether or not this Offer is expired (i.e. it has a past "expiration_date").
is_pay_per_call	Not present for all API calls. Indicates whether or not this Offer supports pay-per-call conversions.
modified	Timestamp of most recent change to object
monthly_conversion_cap	Maximum number of conversions allowed per month for this Offer. If value is set to "0" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
monthly_payout_cap	Maximum payout allowed per month for this Offer. If value is set to "0.00" then there is no cap; note: Some Networks may choose to use this feature but this field is not present by default.
name	The Offer's name
payout_cap	Maximum payout allowed per day for this Offer. If value is set to "0.00" then there is no cap; note: Some Networks may choose to use this feature but this field not present by default.
payout_type	Specifies the method of calculating payout for this Offer. "cpa_flat", "cpm", and "cpc" indicate 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 Offer. For example, a value of "25.00" would indicate a 25% payout. Applicable only for Offers whose "payout_type" includes a percent component, i.e. "cpa_percentage" and "cpa_both".
preview_url	URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
protocol	Conversion tracking method to use for the offer.
require_approval	Whether or not Affiliates must apply to run the Offer
require_terms_and_conditions	Whether or not this Offer requires acceptance of offer terms and conditions before an Affiliate can run it. The text of the terms and conditions is in the "terms_and_conditions" field. Important: Use "enabled" and "disabled" for all inputs, including for filter options. However, values the API returns are "0" for disabled and "1" for enabled.
show_custom_variables	Whether or not custom variables can be used in tracking links. For more information, see: https://support.hasoffers.com/entries/20718333-Adding-custom-variables-to-tracking-links.
show_mail_list	Indicates that a DNE List is attached to this Offer. See the "dne_list_id" field for the ID of the list, and the "dne_download_url" and the related "dne_unsubscribe_url" fields.
status	The status of the Offer. Affiliates can only view active Offers.
terms_and_conditions	The terms and conditions Affiliates must agree to in order to run this Offer. Should be present if "require_terms_and_conditions" is set to "enabled".
use_target_rules	Whether or not this Offer has Advanced Targeting enabled. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202305356-Advanced-Targeting.

Show Supported Values

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

GET Response Notes

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.