OfferUrl::findAll | TUNE Dev Hub

Jump to: GET Response Notes | API Call Builder

Find Offer Urls.

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

Name	Description
created	The date this Offer URL was created
id	ID of unique, auto-generated object for this Offer URL
is_private	Whether this Offer URL should be visible to Affiliates
modified	The last time this Offer URL was updated
name	The name of the Offer URL
offer_id	The ID of the Offer this URL is for
offer_url	The URL to redirect all tracking links for the Offer URL. There are several optional variables that can be included in the "offer_url" which will be replaced before redirection. Affiliate ID - Include {affiliate_id} and it will be replaced by the ID of the Affiliate promoting the offer. Affiliate Sub ID - Include {aff_sub} and it will be replaced by the value of Affiliate Sub ID passed in via an affiliate tracking link. Affiliate Source - Include {source} and it will be replaced by the value of Affiliate Source passed in via an affiliate tracking link. Offer ID - Include {offer_id} and it will be replaced by the ID of the Offer. Offer URL ID - Include {offer_url_id} and it will be replaced by the ID of the Offer URL used. Advertiser ID - Include {advertiser_id} and it will be replaced by the ID of the Advertiser of the offer. Country Code - Include {country_code} and it will be replaced by the user's country code (ISO 2-letter code, i.e. US). Custom Variables - Include {params} if the Custom Variables option above is enabled. {params} will be replaced by the extra variables passed by the Affiliate into the affiliate tracking link. Transaction ID - Include {transaction_id} to send a unique transaction number to the Advertiser. Use this when trying to verify individual leads or when server response tracking is required. Offer Reference ID - Include {offer_ref} and it will be replaced by the Reference ID of the offer. Affiliate Reference ID - Include {affiliate_ref} and it will be replaced by the Reference ID of the Affiliate promoting the offer. Advertiser Reference ID - Include {advertiser_ref} and it will be replaced by the Reference ID of the Advertiser of the offer.
preview_url	A URL that often skips any geo-targeting or other re-targeting implemented on the "offer_url". Allows users to view a sample landing page.
status	The status of this Offer URL

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
created	The date this Offer URL was created
id	ID of unique, auto-generated object for this Offer URL
is_private	Whether this Offer URL should be visible to Affiliates
modified	The last time this Offer URL was updated
name	The name of the Offer URL
offer_id	The ID of the Offer this URL is for
offer_url	The URL to redirect all tracking links for the Offer URL. There are several optional variables that can be included in the "offer_url" which will be replaced before redirection. Affiliate ID - Include {affiliate_id} and it will be replaced by the ID of the Affiliate promoting the offer. Affiliate Sub ID - Include {aff_sub} and it will be replaced by the value of Affiliate Sub ID passed in via an affiliate tracking link. Affiliate Source - Include {source} and it will be replaced by the value of Affiliate Source passed in via an affiliate tracking link. Offer ID - Include {offer_id} and it will be replaced by the ID of the Offer. Offer URL ID - Include {offer_url_id} and it will be replaced by the ID of the Offer URL used. Advertiser ID - Include {advertiser_id} and it will be replaced by the ID of the Advertiser of the offer. Country Code - Include {country_code} and it will be replaced by the user's country code (ISO 2-letter code, i.e. US). Custom Variables - Include {params} if the Custom Variables option above is enabled. {params} will be replaced by the extra variables passed by the Affiliate into the affiliate tracking link. Transaction ID - Include {transaction_id} to send a unique transaction number to the Advertiser. Use this when trying to verify individual leads or when server response tracking is required. Offer Reference ID - Include {offer_ref} and it will be replaced by the Reference ID of the offer. Affiliate Reference ID - Include {affiliate_ref} and it will be replaced by the Reference ID of the Affiliate promoting the offer. Advertiser Reference ID - Include {advertiser_ref} and it will be replaced by the Reference ID of the Advertiser of the offer.
preview_url	A URL that often skips any geo-targeting or other re-targeting implemented on the "offer_url". Allows users to view a sample landing page.
status	The status of this Offer URL

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
OfferUrl.created	The date this Offer URL was created
OfferUrl.id	ID of unique, auto-generated object for this Offer URL
OfferUrl.is_private	Whether this Offer URL should be visible to Affiliates
OfferUrl.modified	The last time this Offer URL was updated
OfferUrl.name	The name of the Offer URL
OfferUrl.offer_id	The ID of the Offer this URL is for
OfferUrl.offer_url	The URL to redirect all tracking links for the Offer URL. There are several optional variables that can be included in the "offer_url" which will be replaced before redirection. Affiliate ID - Include {affiliate_id} and it will be replaced by the ID of the Affiliate promoting the offer. Affiliate Sub ID - Include {aff_sub} and it will be replaced by the value of Affiliate Sub ID passed in via an affiliate tracking link. Affiliate Source - Include {source} and it will be replaced by the value of Affiliate Source passed in via an affiliate tracking link. Offer ID - Include {offer_id} and it will be replaced by the ID of the Offer. Offer URL ID - Include {offer_url_id} and it will be replaced by the ID of the Offer URL used. Advertiser ID - Include {advertiser_id} and it will be replaced by the ID of the Advertiser of the offer. Country Code - Include {country_code} and it will be replaced by the user's country code (ISO 2-letter code, i.e. US). Custom Variables - Include {params} if the Custom Variables option above is enabled. {params} will be replaced by the extra variables passed by the Affiliate into the affiliate tracking link. Transaction ID - Include {transaction_id} to send a unique transaction number to the Advertiser. Use this when trying to verify individual leads or when server response tracking is required. Offer Reference ID - Include {offer_ref} and it will be replaced by the Reference ID of the offer. Affiliate Reference ID - Include {affiliate_ref} and it will be replaced by the Reference ID of the Affiliate promoting the offer. Advertiser Reference ID - Include {advertiser_ref} and it will be replaced by the Reference ID of the Advertiser of the offer.
OfferUrl.preview_url	A URL that often skips any geo-targeting or other re-targeting implemented on the "offer_url". Allows users to view a sample landing page.
OfferUrl.status	The status of this Offer URL

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 Offer Url model objects.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.