API:API Network Offers(Legacy)

From HasOffers

Contents

Definition

Returns a list of offers.

  • Formats: json, xml, csv
  • HTTP Method: GET
  • Authentication: This API requires user authentication. Your API key should be passed with the request to provide authentication.


Required Parameters


Optional Parameters



Response

Field Definitions

id int The unique indentifier of the offers.

advertiser_id int The indentifier of advertiser this offer belongs to. The field may be empty.

description string General information about the offer.

terms_and_conditions string Special terms pertaining to the offer, which affiliates must agree to before pushing the offer. These special terms and conditions are optional.

payout_type flat, percentage, both The type of conversion payment to affiliates. Flat is a consistant payout for all conversions. Percentage is a payout based on a percentage of advertiser-reported sales. Both is a combination of the two. The default payout_type is flat.

default_payout decimal The flat payout rate given to affiliates if the payout_type is flat or both.

max_payout decimal The amount of revenue you expect to receive from the advertiser per conversion. Max payout is a 'soft' ceiling for the amount you can pay an affiliate and still retain a profit.

percent_payout int The percentage paid to affilaites based on the sale amount of the conversion as reported by the advertiser.

protocol http, https, http_img, https_img, server The protocol to use for reporting conversions. Http and https are reported with iframes and allow third party conversion pixels. Http_img and https_img are reported with image pixels and do not allow third party conversion pixels. Server is server response reporting and requires a transaction id to be passed to the advertiser and from the advertiser to us for accurate reporting. Server response reporting is best used only when the adveriser cannot use the other 'web-based' reporting protocols. Default protocol is http

status pending, active, paused, deleted The status of the offer. Default status is pending.

expiration_date date The day the offer expires. Offers being pushed after expiration will either redirect to another offer, if applicable, or will receive an error.

cookie_hours int The number of hours to store click information in order to consider a conversion valid. Default is 24 hours.

conversion_cap int The number of conversions an offer may obtain per day. Offers being pushed after the lead cap is exceeded will be redirected to another offer, if applicable, or will receive an error. A lead_cap of 0 allows for unlimited conversions. The default value is 0.

preview_url string (url) A basic landing page with no geo targeting so Affiliates can see landing page examples.

offer_url string (url) Actual offer url users will be redirected to. The system will dynamically replace the following variables on redirect: '{affiliate_id}' for Affiliate ID, '{offer_id}' for Offer ID, '{offer_url_id}' for Creative URL ID, '{source}' for Affiliate Source, '{aff_sub}' for Affiliate Sub ID, and '{params}' to pass all additional query information to landing page.

redirect_offer_id int The unique identifier of the offers to redirect to when a user clicks on an unconvertable offer link. Offers can be redirected for a number of reasons, including exceeded lead caps and expiration dates.

converted_offer_type network, url, (empty) Determines how to handle offers that have already converted with a user. Network will redirect to another offer on your network as specified by the converted_offer_id. Network converted offers will be tracked in our system as normal. Url will redirect users to the url specified by converted_offer_url. Offer redirected using the url option will not be tracked by our system. If left empty, the offer will not redirect the user even if the offer has been converted.

converted_offer_id int The unique identifier of the offer to redirect users to when the user has already converted the offer. This only applies if converted_offer_type is set to network.

converted_offer_url string (url) The url to redirect users to when the user has already converted the offer. This only applies if converted_offer_type is set to url.

is_private bool Determines if the offer should be hidden from Affiliates by default. Default is false

allow_multiple_conversions bool Determines if the offer allows multiple conversions. Default is false.

allow_website_links bool Allows affiliates to pull links from the website and redirect their tracking links to specific pages. Default is false.

show_custom_variables bool Allow affiliates to insert custom variables into the tracking link that are passed to the offer creative URL via params. Default is false

show_mail_list bool Determines whether email suppression lists should be available for the offer. This is not typically required unless the offer is an email campaign. Default is false.

JSON Example

. 


          {
              "success":true
              ,"rows":2
              ,"total_rows":24
              ,"data":{
                  "offers":[
                      {
                          "id":"130"
                          ,"advertiser_id":"3"
                          ,"name":"2Insure4Less Auto Form (Extra Variables HTTPS)"
                          ,"description":"Automobile insurance offer for one of the Internet's largest insurance portals. Conversion upon first page short form submit. Email, banner, search, pop-up and contextual traffic accepted. Incentivized traffic is not permitted. Custom Variables that can be passed in are "firstname", "lastname" and "zipcode"."
                          ,"terms_and_conditions":""
                          ,"payout_type":"flat"
                          ,"default_payout":"4.00"
                          ,"max_payout":"5.00"
                          ,"percent_payout":"0"
                          ,"protocol":"https"
                          ,"status":"active"
                          ,"expiration_date":"2010-06-11"
                          ,"cookie_hours":"24"
                          ,"conversion_cap":"0"
                          ,"preview_url":"https:\/\/www.2insure4less.com\/quotes\/am\/default.aspx"
                          ,"offer_url":"http:\/\/www.coolred.com\/insurance\/index.php?{params}"
                          ,"redirect_offer_id":""
                          ,"converted_offer_type":""
                          ,"converted_offer_id":""
                          ,"converted_offer_url":""
                          ,"is_private":"0"
                          ,"allow_multiple_conversions":"0"
                          ,"allow_website_links":"0"
                          ,"show_custom_variables":"1"
                          ,"show_mail_list":"0"
                      }
                      ,{
                          "id":"94"
                          ,"advertiser_id":"10"
                          ,"name":"Acai Burn (Server Response)"
                          ,"description":"High converting Acai offer. US, Canada, Australia, New Zealand and UK traffic accepted. Cannot be incentivized."
                          ,"terms_and_conditions":""
                          ,"payout_type":"flat"
                          ,"default_payout":"22.00"
                          ,"max_payout":"25.00"
                          ,"percent_payout":"15"
                          ,"protocol":"server"
                          ,"status":"active"
                          ,"expiration_date":"2010-06-15"
                          ,"cookie_hours":"672"
                          ,"conversion_cap":"0"
                          ,"preview_url":"http:\/\/www.acaiburn.com\/"
                          ,"offer_url":"http:\/\/www.acaiburn.com\/?transaction_id={transaction_id}"
                          ,"redirect_offer_id":"212"
                          ,"converted_offer_type":""
                          ,"converted_offer_id":""
                          ,"converted_offer_url":""
                          ,"is_private":"0"
                          ,"allow_multiple_conversions":"0"
                          ,"allow_website_links":"0"
                          ,"show_custom_variables":"0"
                          ,"show_mail_list":"0"
                      }
                  ]
              }
          }

XML Example

. 


      <rsp stat="ok" rows="2" total_rows="24">
          <offer>
              <id>130</id>
              <advertiser_id>3</advertiser_id>
              <name>2Insure4Less Auto Form (Extra Variables HTTPS)</name>
              <description>
                  Automobile insurance offer for one of the Internet's largest insurance portals. Conversion upon first page short form submit. Email, banner, search, pop-up and contextual traffic accepted. Incentivized traffic is not permitted. Custom Variables that can be passed in are "firstname", "lastname" and "zipcode".
              </description>
              <terms_and_conditions/>
              <payout_type>flat</payout_type>
              <default_payout>4.00</default_payout>
              <max_payout>5.00</max_payout>
              <percent_payout>0</percent_payout>
              <protocol>https</protocol>
              <status>active</status>
              <expiration_date>2010-06-11</expiration_date>
              <cookie_hours>24</cookie_hours>
              <conversion_cap>0</conversion_cap>
              <preview_url>
                  https://www.2insure4less.com/quotes/am/default.aspx
              </preview_url>
              <offer_url>
                  http://www.coolred.com/insurance/index.php?{params}
              </offer_url>
              <redirect_offer_id/>
              <converted_offer_type/>
              <converted_offer_id/>
              <converted_offer_url/>
              <is_private>0</is_private>
              <allow_multiple_conversions>0</allow_multiple_conversions>
              <allow_website_links>0</allow_website_links>
              <show_custom_variables>1</show_custom_variables>
              <show_mail_list>0</show_mail_list>
          </offer>
          <offer>
              <id>94</id>
              <advertiser_id>10</advertiser_id>
              <name>Acai Burn (Server Response)</name>
              <description>
                  High converting Acai offer. US, Canada, Australia, New Zealand and UK traffic accepted. Cannot be incentivized.
              </description>
              <terms_and_conditions/>
              <payout_type>flat</payout_type>
              <default_payout>22.00</default_payout>
              <max_payout>25.00</max_payout>
              <percent_payout>15</percent_payout>
              <protocol>server</protocol>
              <status>active</status>
              <expiration_date>2010-06-15</expiration_date>
              <cookie_hours>672</cookie_hours>
              <conversion_cap>0</conversion_cap>
              <preview_url>http://www.acaiburn.com/</preview_url>
              <offer_url>
                  http://www.acaiburn.com/?transaction_id={transaction_id}
              </offer_url>
              <redirect_offer_id>212</redirect_offer_id>
              <converted_offer_type/>
              <converted_offer_id/>
              <converted_offer_url/>
              <is_private>0</is_private>
              <allow_multiple_conversions>0</allow_multiple_conversions>
              <allow_website_links>0</allow_website_links>
              <show_custom_variables>0</show_custom_variables>
              <show_mail_list>0</show_mail_list>
          </offer>
      </rsp>
Retrieved from "http://wiki.hasoffers.com/wiki/API:API_Network_Offers(Legacy)"

 
Email this page to a friend or co-worker