REPORTS SourceAffiliateSummary Api Version 3

Timothy Johnson

Modified on: Mon, 18 Jan, 2021 at 1:28 PM

REPORTS SourceAffiliateSummary API Version 3

Updated on 2016-05-26
Current Version: Version 3
Requests Allowed: HTTP GET / HTTP POST / SOAP 1.1 / SOAP 1.2

Summary:

Performance summary based on source/affiliate id.

Resource/WSDL Page:

http://YourAdminDomain.com/api/3/reports.asmx?op=SourceAffiliateSummary

Parameters

api_key Required Type: STRING	Administrative API key. Example Values: Obtained from the Setup tab - Permissions sub tab.
start_date Required Value Type: DATETIME	Start date for your report. Example Values: MM/DD/YYYY hh:mm:ss, YYYY-MM-DD hh:mm:ss
end_date Required Value Type: DATETIME	End date for your report. When time stamp is excluded 00:00:00 is assumed. Data on end date will not be included. Example Values: MM/DD/YYYY, hh:mm:ss, YYYY-MM-DD hh:mm:ss **You can only pull one month increments maximum
source_affiliate_id Required Value Type: INT	Obtained via EXPORT Affiliates API. Pass 0 for all Example Values: 1289
source_affiliate_manager_id Required Value Type: INT	Obtained via EXPORT Affiliates API Example Values: 87
source_affiliate_tag_id Required Value Type: INT	Obtained via GET AffiliateTags API Example Values: 28
site_offer_tag_id Required Value Type: INT	Obtained via EXPORT Offers API Example Values: 44
event_id Required Value Type: INT	Obtained via EXPORT Offers API Example Values: 4
event_type Required Value Type: ENUMERATION	Filter based on how revenue was generated (events, conversions or both) Example Values: macro_event_conversions, micro_events, all

**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	https://demo-new.cakemarketing.com/api/3/reports.asmx/SourceAffiliateSummary?api_key=3YmDJeT3VHTFhDqAjr2OlQ&start_date=05-01-2016&end_date=05-31-2016&source_affiliate_id=0&source_affiliate_manager_id=0&source_affiliate_tag_id=0&site_offer_tag_id=0&event_id=0&event_type=all

Sample XML Response:

<source_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/3/">
<success>true</success>
<row_count>2</row_count>
<source_affiliates>
<source_affiliate_summary>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">1112617</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">- Gazipura &amp; Partners</source_affiliate_name>
</source_affiliate>
<account_manager>
<account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
<account_manager_name xmlns="API:id_name_store">John</account_manager_name>
</account_manager>
<views>3</views>
<clicks>47</clicks>
<click_thru_percentage>1566.666700</click_thru_percentage>
<macro_event_conversions>41.000000</macro_event_conversions>
<paid>6.000000</paid>
<sellable>41.000000</sellable>
<micro_events>0.000000</micro_events>
<macro_event_conversion_percentage>12.765900</macro_event_conversion_percentage>
<cost>273.5000</cost>
<average_cost>6.670732</average_cost>
<epc>5.819149</epc>
<revenue>112.5000</revenue>
<revenue_per_transaction>2.743902</revenue_per_transaction>
<margin>-143.1100</margin>
<profit>-161.0000</profit>
<pending>0.000000</pending>
<rejected>0.000000</rejected>
<approved>36.000000</approved>
<returned>0.000000</returned>
<orders>0</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
<average_macro_event_conversion_score>0.00</average_macro_event_conversion_score>
<paid_events>0.000000</paid_events>
<total_paid>6.000000</total_paid>
</source_affiliate_summary>
<source_affiliate_summary>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">1114414</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">- Gazipura &amp; Partners</source_affiliate_name>
</source_affiliate>
<account_manager>
<account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
<account_manager_name xmlns="API:id_name_store">John</account_manager_name>
</account_manager>
<views>0</views>
<clicks>3</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<macro_event_conversions>3.000000</macro_event_conversions>
<paid>2.000000</paid>
<sellable>3.000000</sellable>
<micro_events>0.000000</micro_events>
<macro_event_conversion_percentage>66.666600</macro_event_conversion_percentage>
<cost>95.0000</cost>
<average_cost>31.666667</average_cost>
<epc>31.666667</epc>
<revenue>90.0000</revenue>
<revenue_per_transaction>30.000000</revenue_per_transaction>
<margin>-5.5500</margin>
<profit>-5.0000</profit>
<pending>0.000000</pending>
<rejected>0.000000</rejected>
<approved>3.000000</approved>
<returned>0.000000</returned>
<orders>0</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
<average_macro_event_conversion_score>0.00</average_macro_event_conversion_score>
<paid_events>0.000000</paid_events>
<total_paid>2.000000</total_paid>
</source_affiliate_summary>
</source_affiliates>
</source_affiliate_summary_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired
Invalid source_affiliate_id	source_affilaite_id does not exist
Cannot convert to System.Int32. Parameter name: type ---> Input string was not in a correct format.	Passing a NULL value instead of 0 on a field requiring an ID.