DEPRECATED - [Reports] TopOfferSummary (V2) - Affiliate

Ron Torres

Modified on: Wed, 23 Sep, 2015 at 9:00 AM

NOTICE: THIS VERSION OF THE API HAS BEEN DEPRECATED. IT WILL CONTINUE TO WORK INDEFINITELY, BUT HAS INCREASED FUNCTIONALITY IN NEWER VERSIONS.

WSDL Page: http://<your_domain_here>/affiliate/api/2/offers.asmx?op=TopOfferSummary

Parameter Summary:

api_key / STRING = Affiliate API Key {See auth.asmx > Login}

affiliate_id / INT = Affiliate ID {See auth.asmx > Login}

start_date / DATETIME = Report Start Date [MM/DD/YYYY HH:MM:SS]

end_date / DATETIME = Report End Date [MM/DD/YYYY HH:MM:SS]

vertical_id / INT (short) = Vertical ID ["0" = ALL Verticals] {See offers.asmx > GetVerticals}

start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]

row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]

Parameter Types:

api_key - ID

affiliate_id - ID

start_date - ID

end_date - ID

vertical_id - ID

start_at_row - ASSIGNABLE

row_limit - ASSIGNABLE

Sample GET Call:

https://demo.cakemarketing.com/affiliates/api/2/reports.asmx/TopOfferSummary?api_key=LRKjY66p5iQz1WTtPMy6Q&affiliate_id=2699&start_date=06/01/2013+00:00:00&end_date=07/01/2013+01:00:00&vertical_id=0&start_at_row=1&row_limit=3

Sample XML Response:

<top_offer_summary_response>
   <success>true</success>
   <row_count>2</row_count>
   <top_offers>
      <top_offer>
         <offer_id>290</offer_id>
         <offer_name>WINNING T-Shirts</offer_name>
         <epc>105.481481</epc>
         <currency_symbol>£</currency_symbol>
      </top_offer>
      <top_offer>
         <offer_id>358</offer_id>
         <offer_name>Offer 358</offer_name>
         <epc>0.225352</epc>
         <currency_symbol>£</currency_symbol>
      </top_offer>
   </top_offers>
</top_offer_summary_response>

Related Articles