CAKE Help & Support

REPORTS AffiliateSummary API Version 2

Modified on: Wed, 11 May, 2016 at 2:15 PM


Reports AffiliateSummary API V2

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

 

Summary:

Returns an affiliate performance overview

 

Resource/WSDL Page:

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


 

Parameters 

api_key
Required
Type: String
Length (Max):  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 (Max/Min):  NA

 

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

end_date
Required 
Type: Date
Length (Max/Min):  NA

When time stamp is excluded 00:00:00 is assumed. Data on end date will not be included.

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


**You can only pull one month increments maximum

affiliate_id
Optional
Type: INT
Length (Max/Min):  NA

 

 

The Affiliate ID can be collected from the UI in the affiliate Card.

 

Example Values: 7894

affiliate_manager_id
Optional
Type: INT
Length (Max/Min):  NA

 

ID of the affiliate manager, you can obtain from the UI in the contact card of the affiliate manager.

 

Example Values: 4,43,657

affiliate_tag_id
Optional
Type: Short
Length (Max/Min):  NA

 

This is the ID of the tag the affiliate has been tagged with. Currently is unavailable via the User Interface, but can be retrieved using the AffiliateTags API.

Example Values: 3, 5, 78

offer_tag_id
Required Value/Optional?
Type: Short
Length (Max/Min):  NA

This is the ID of the tag the Offer has been tagged with. Currently is unavailable via the User Interface.

Example Values: 75, 94

 

event_id
Optional?
Type: int
Length (Max/Min):  NA

 

The Id of the conversion. Can be found on the offer or the advertiser card under events.

Example Values: 84, 64

revenue_filter
Required Value
Type: STRING
Length (Max/Min):  NA

Allows you to filter for conversions, Events or both.

Example Values: 

"conversions_and_events", "conversions" or "events"

 **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/2/reports.asmx/AffiliateSummary?api_key=dNJFmId9rI&start_date=2014-03-01&end_date=2014-04-01&affiliate_id=0&affiliate_manager_id=0&affiliate_tag_id=0&offer_tag_id=0&event_id=0&revenue_filter=conversions_and_events 

 

Sample XML Response:

<affiliate_summary_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/2/">
<success>true</success>
<row_count>1</row_count>
<affiliates>
<affiliate_summary>
<affiliate>
<affiliate_id xmlns="API:id_name_store">5920</affiliate_id>
<affiliate_name xmlns="API:id_name_store">@Test1231</affiliate_name>
</affiliate>
<account_manager>
<account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
<account_manager_name xmlns="API:id_name_store">John Doe</account_manager_name>
</account_manager>
<views>0</views>
<clicks>4</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<conversions>8</conversions>
<paid>5</paid>
<sellable>8</sellable>
<events>0</events>
<conversion_percentage>125.000000</conversion_percentage>
<cost>20.0000</cost>
<average_cost>2.500000</average_cost>
<epc>5.000000</epc>
<revenue>70.0000</revenue>
<revenue_per_transaction>8.750000</revenue_per_transaction>
<margin>71.4200</margin>
<profit>50.0000</profit>
<pending>0</pending>
<rejected>0</rejected>
<approved>0</approved>
<returned>0</returned>
<orders>0</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
<average_conversion_score xsi:nil="true"/>
</affiliate_summary>
</affiliates>
</affiliate_summary_response>

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.
Login
New support ticket Check ticket status