Reports AffiliateSummary API

Updated on 2014-04-01
Current Version: Version 1
Latest Version: 2
Requests Allowed: GET/POST/SOAP/

 

Summary:

This API will allow you to see a summary of all campaigns ran by an affiliate during a certain period of time. It allows to filter down by Affiliate, offer or Campaign ID 

This is the equivalent to running an affiliate report in the UI and drilling down to campaigns. 

 

Resource/WSDL Page:

http://<your_domain_here>/api/1/reports.asmx?op=AffiliateSummary

 

Parameters

 

 

api_key
Required
Type: String
Length: 50

As an administrator to your CAKE instance, you can obtain your API key in one of two ways. 1.) From within your instance >> setup tab >> permissions. 2.) Using the GET GetAPIKey

Example Values: dNJFmId9rIZZrs

start_date
Required 
Type: Date
Length NA

 

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"

end_date
Required 
Type: Date
Length NA

 

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"

affiliate_id
Optional
Type: INT
Length: NA

 If passing anything <= 0 the result will include all affiliates.

 

The Affiliate ID can be collected in the 

 

Example Values: 7894

offer_id
Optional
Type: INT
Length: NA

If passing anything <= 0 the result will include all offers.

 Example Values: 4875

campaign_id
Optional
Type: INT
Length: NA

If passing anything <= 0 the result will include all campaigns.

Example Values: 48686 

 **Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 

Example Request

GET 

 http://demo.cakemarketing.com/api/1/reports.asmx/AffiliateSummary?api_key=dNJFmId9rI&start_date=2014-03-15&end_date=2014-04-01&affiliate_id=1111298&offer_id=0&campaign_id=0

 

Sample XML Response:

 <ArrayOfCampaign><Campaign><affiliate_id>1111298</affiliate_id><affiliate_name>Eric's Affiliate</affiliate_name><offer_id>55378078</offer_id><offer_name>Cake link to Cake link Offer</offer_name><campaign_id>27083</campaign_id><impressions>0</impressions><clicks>4</clicks><paid>1</paid><conversion_rate>0.250000</conversion_rate><throttle_percentage>0.000000</throttle_percentage><cost>15.0000</cost><epc>3.750000</epc></Campaign><Campaign><affiliate_id>1111298</affiliate_id><affiliate_name>Eric's Affiliate</affiliate_name><offer_id>55378077</offer_id><offer_name>Cake link to Cake link Thank You</offer_name><campaign_id>27084</campaign_id><impressions>0</impressions><clicks>1</clicks><paid>0</paid><conversion_rate>0.000000</conversion_rate><throttle_percentage>0.000000</throttle_percentage><cost>0.0000</cost><epc>0.000000</epc></Campaign><Campaign><affiliate_id>1111298</affiliate_id><affiliate_name>Eric's Affiliate</affiliate_name><offer_id>55378051</offer_id><offer_name>Conversion Changes</offer_name><campaign_id>27005</campaign_id><impressions>0</impressions><clicks>1</clicks><paid>1</paid><conversion_rate>1.000000</conversion_rate><throttle_percentage>0.000000</throttle_percentage><cost>3.0000</cost><epc>3.000000</epc></Campaign><Campaign><affiliate_id>1111298</affiliate_id><affiliate_name>Eric's Affiliate</affiliate_name><offer_id>55378047</offer_id><offer_name>Disable Lead Tier</offer_name><campaign_id>26986</campaign_id><impressions>0</impressions><clicks>0</clicks><paid>3</paid><conversion_rate>0.000000</conversion_rate><throttle_percentage>0.000000</throttle_percentage><cost>22.0000</cost><epc>0.000000</epc></Campaign><Campaign><affiliate_id>1111298</affiliate_id><affiliate_name>Eric's Affiliate</affiliate_name><offer_id>55378075</offer_id><offer_name>Test Lead Update</offer_name><campaign_id>27079</campaign_id><impressions>0</impressions><clicks>0</clicks><paid>59</paid><conversion_rate>0.000000</conversion_rate><throttle_percentage>0.000000</throttle_percentage><cost>295.0000</cost><epc>0.000000</epc></Campaign><Campaign><affiliate_id>1111298</affiliate_id><affiliate_name>Eric's Affiliate</affiliate_name><offer_id>55378060</offer_id><offer_name>Throttle session post</offer_name><campaign_id>27038</campaign_id><impressions>0</impressions><clicks>3</clicks><paid>2</paid><conversion_rate>0.666666</conversion_rate><throttle_percentage>0.000000</throttle_percentage><cost>20.0000</cost><epc>6.666666</epc></Campaign></ArrayOfCampaign>