Offer Controller

Create, manipulate, and retrieve offers and offer-related information. Manage affiliate access to offers.

Methods

addApprovalQuestion

Creates a signup approval question for an offer

addCategory

Associates an offer to an offer category

addGeoTargeting

Add new locations—cities, regions, and countries—to an offer's geotargeting definition

addGroup

Associates an offer to an offer group

addTargetBrowser

[Deprecated]

addTargetCountry

Associates an offer with a country or with specified regions within a country

addTargetCountryRegion

Associates an offer with a country or with a specified region within a country

blockAffiliate

Blocks an affiliate from access to an offer

create

Creates an offer

findAll

Returns one or more offers, optionally filtered and sorted

findAllAffiliateApprovals

Returns affiliate offer approvals

findAllByIds

Returns offers by their IDs

findAllFeaturedOfferIds

Returns IDs of active, featured offers

findAllIds

Returns IDs of offers

findAllIdsByAdvertiserId

Returns IDs of offers associated with a given advertiser

findAllIdsByAffiliateId

Returns IDs of offers associated with an affiliate

findAllOfferAffiliateBlocks

Retrieve all OfferAffiliateBlock objects

findAllOptimizerExcludedOffers

Retrieve all offers that are excluded from automation

findById

Returns an offer by its ID

generateTrackingLink

Generates a tracking link for an offer and affiliate

generateTrackingPixel

Generates a tracking pixel for an offer

getAffiliateApplicationNote

Returns affiliate offer approval notes for an affiliate and offer

getAffiliateApprovalStatus

Returns an affiliate approval status for an offer

getAffiliateHostnames

Returns affiliate-specific custom tracking information for an offer

getAffiliatePayment

Returns payout and revenue information for an offer, affiliate, and (optionally) goal

getAffiliatePayout

Returns payout information for an offer, affiliate, and (optionally) goal

getAffiliateRevenue

Returns revenue information for an offer, affiliate, and (optionally) goal

getAllAffiliateAccessByOffer

Returns a list of affiliate IDs grouped by offer access status ("approved", "blocked", and "unapproved")

getApprovalAnswers

Returns answers an affiliate provided for an offer's approval questions

getApprovalQuestions

Returns signup approval questions

getApprovedAffiliateIds

Returns IDs for affiliates approved for an offer

getBlockedAffiliateIds

Returns IDs for affiliates blocked from an offer

getCategories

Returns all offer categories associated to an offer

getConversionCaps

Returns conversion caps for an offer

getCustomerList

Returns customer list data for a given offer

getGeoTargeting

Returns an offer's geotargeting definition (including cities)

getGroups

Returns all offer groups associated to an offer

getOfferFiles

Returns offer files for an offer

getOfferFilesWithCreativeCode

Returns offer files for an offer; includes creative code for an affiliate

getOfferListByGroupId

Returns offers associated to an offer group

getOfferUrls

Returns offer URLs for an offer

getOverview

Returns an activity overview based on offer and affiliate criteria

getPayouts

Returns all affiliate-specific payout information for an offer

getPixels

Returns offer pixels for an offer

getRevenues

Returns all affiliate-specific revenue information for an offer

getTargetBrowsers

[Deprecated]

getTargetCountries

Returns countries and regions associated to an offer

getThumbnail

Returns the thumbnail associated with an offer

getTierPayouts

Returns affiliate-specific payout tier information for an offer

getTierRevenues

Returns affiliate-specific revenue tier information for an offer

getUnapprovedAffiliateIds

Returns affiliates eligible for an offer but not yet approved

getUnblockedAffiliateIds

Retrieves a list of all affiliate IDs not blocked from an offer.

removeAllGeoTargeting

Removes all locations from an offer's geotargeting definition (including cities)

removeCategory

Removes offer from an offer category

removeConversionCap

Removes affiliate-specific offer conversion cap

removeGeoTargeting

Remove locations from an offer's geotargeting definition

removeGroup

Removes offer from an offer group

removePayout

Removes affiliate-specific payout from an offer and (optionally) goal

removeRevenue

Removes affiliate-specific revenue from an offer and (optionally) goal

removeTargetCountry

Removes an offer's association to a country, including individual regions

removeTargetCountryRegion

Removes an offer's association to a country or specified region within a country

removeTierPayout

Removes affiliate payout tier from an offer and (optionally) goal

removeTierRevenue

Removes affiliate revenue tier from an offer and (optionally) goal

saveApprovalQuestionAnswer

Creates entry for an affiliate's answer to an offer's signup question

setAffiliateApproval

Sets an affiliate's approval status for an offer

setAffiliateHostname

Sets an affiliate's custom tracking domain hostname for an offer

setAffiliateTermsDate

Sets the date an affiliate agreed to an offer's terms and conditions

setCategories

Sets offer categories for an offer

setConversionCap

Sets the conversion cap for an offer

setGeoTargeting

Sets locations—cities, regions, and countries—to an offer's geotargeting definition

setGroups

Associates one or more offer groups to an offer, replacing prior group associations

setMultipleAffiliateApprovals

Bulk updates approval statuses for one or more sets of offers and affiliates

setPayout

Sets affiliate-specific payout from an offer and (optionally) goal

setRevenue

Sets affiliate-specific revenue from an offer and (optionally) goal

setTargetBrowsers

[Deprecated]

setTargetCountries

Associates an offer with one or more countries or with specified regions within countries, replacing prior country/region associations

setTierPayout

Sets affiliate payout tier from an offer and (optionally) goal

setTierRevenue

Sets affiliate revenue tier from an offer and (optionally) goal

unblockAffiliate

Unblocks an affiliate's access to an offer

update

Updates specified properties of an offer

updateApprovalQuestion

Updates an existing signup approval question

updateByRefId

Updates specified properties of an offer based on reference ID

updateField

Updates single property of an offer

Have a Question? Please contact [email protected] for technical support.