Submit a Ticket My Tickets
Welcome
Login  Sign up

[Reports] Referral (V2) - Affiliate

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

 

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]

over_minimum / BOOL = Over Minimum Threshold? ["TRUE", "FALSE"]

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]

sort_field / STRING = Sort Field ["affiliate_id", "affiliate_name", "paid", "commission"]

sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]

 

Parameter Types:

api_key - ID

affiliate_id - ID

start_date - ID

end_date - ID

over_minimum - ASSIGNABLE

start_at_row - ASSIGNABLE

row_limit - ASSIGNABLE

sort_field - ASSIGNABLE

sort_descending - ASSIGNABLE

 

Sample GET Call:

https://demo.cakemarketing.com/affiliates/api/2/reports.asmx/Referral?api_key=bhGHqfji5JNOhhE9jTvcA&affiliate_id=69&start_date=01/07/2013+00:00:00&end_date=06/29/2013+01:00:00&over_minimum=FALSE&start_at_row=1&row_limit=3&sort_field=affiliate_id&sort_descending=FALSE


Sample XML Response:

<referral_response>
   <success>true</success>
   <row_count>1</row_count>
   <summary>
      <paid>512</paid>
      <commission>1449.87498883</commission>
      <currency_symbol>$</currency_symbol>
   </summary>
   <referrals>
      <referral>
         <affiliate>
            <affiliate_id>4581</affiliate_id>
            <affiliate_name>CPA Super Affiliate 5000</affiliate_name>
         </affiliate>
         <paid>512</paid>
         <commission>1449.87498883</commission>
         <currency_symbol>$</currency_symbol>
      </referral>
   </referrals>
</referral_response>

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.