Reports SubIDSummary API Version 1

Created On 11/25/15
Current Version: Version 1

Deprecated Versions: N/A
Requests Allowed: GET/POST/SOAP


Summary:

Returns summary report of an Affiliate's SubIDs. Can pull up to one month of data per call.


Resource/WSDL Page:

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

 

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"

Example Values: 2015-07-01

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

***Max date range is 31 days

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

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

Example Values: 2015-08-01

source_affiliate_id
Required
Type: INT
Length (Max/Min):  NA

Source/Affiliate id

Affiliate ID. Use EXPORT Affiliates API

Example Values: 7894

site_offer_id
Required
Type: Short
Length (Max/Min):  NA


Filter for a specific offer/site. Pass 0 for all offers/sites. Use EXPORT Offers API

Example Values: 75, 94

 

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

 
Filter for a specific event id. Use EXPORT Advertisers API or EXPORT Offers API

Example Values: 84, 64

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


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/1/reports.asmx/SubIDSummary?api_key=dNJFmId9rI&start_date=2015-08-01&end_date=2015-09-01&source_affiliate_id=1111667&site_offer_id=0&event_id=0&revenue_filter=conversions_and_events




Sample XML Response:

 

<sub_id_summary_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/1/">
<success>true</success>
<row_count>3</row_count>
<sub_ids>
<sub_id_summary>
<sub_id>134686</sub_id>
<sub_id_name>Click1</sub_id_name>
<views>0</views>
<clicks>1</clicks>
<click_thru>0.000000</click_thru>
<macro_event_conversions>1.000000</macro_event_conversions>
<macro_event_conversion_percentage>100.000000</macro_event_conversion_percentage>
<paid_macro_event_conversions>1.000000</paid_macro_event_conversions>
<sellable_macro_event_conversions>1.000000</sellable_macro_event_conversions>
<micro_events>0.000000</micro_events>
<cost>2.0000</cost>
<average_cost>2.000000</average_cost>
<epc>2.000000</epc>
<revenue>5.0000</revenue>
<revenue_per_transaction>5.000000</revenue_per_transaction>
<margin>0.6000</margin>
<profit>3.0000</profit>
<pending>0.000000</pending>
<rejected>0.000000</rejected>
<approved>1.000000</approved>
<returned>0.000000</returned>
<orders>0.000000</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
<average_macro_event_conversion_score xsi:nil="true"/>
<paid_micro_events>0.000000</paid_micro_events>
<total_paid>1.000000</total_paid>
</sub_id_summary>
<sub_id_summary>
<sub_id>134658</sub_id>
<sub_id_name>Click3</sub_id_name>
<views>0</views>
<clicks>1</clicks>
<click_thru>0.000000</click_thru>
<macro_event_conversions>2.000000</macro_event_conversions>
<macro_event_conversion_percentage>200.000000</macro_event_conversion_percentage>
<paid_macro_event_conversions>2.000000</paid_macro_event_conversions>
<sellable_macro_event_conversions>2.000000</sellable_macro_event_conversions>
<micro_events>0.000000</micro_events>
<cost>4.0000</cost>
<average_cost>2.000000</average_cost>
<epc>4.000000</epc>
<revenue>10.0000</revenue>
<revenue_per_transaction>5.000000</revenue_per_transaction>
<margin>0.6000</margin>
<profit>6.0000</profit>
<pending>1.000000</pending>
<rejected>0.000000</rejected>
<approved>1.000000</approved>
<returned>0.000000</returned>
<orders>0.000000</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
<average_macro_event_conversion_score xsi:nil="true"/>
<paid_micro_events>0.000000</paid_micro_events>
<total_paid>2.000000</total_paid>
</sub_id_summary>
<sub_id_summary>
<sub_id>137162</sub_id>
<sub_id_name>test1</sub_id_name>
<views>0</views>
<clicks>9</clicks>
<click_thru>0.000000</click_thru>
<macro_event_conversions>3.000000</macro_event_conversions>
<macro_event_conversion_percentage>33.333300</macro_event_conversion_percentage>
<paid_macro_event_conversions>3.000000</paid_macro_event_conversions>
<sellable_macro_event_conversions>3.000000</sellable_macro_event_conversions>
<micro_events>0.000000</micro_events>
<cost>75.0000</cost>
<average_cost>25.000000</average_cost>
<epc>8.333333</epc>
<revenue>150.0000</revenue>
<revenue_per_transaction>50.000000</revenue_per_transaction>
<margin>0.5000</margin>
<profit>75.0000</profit>
<pending>0.000000</pending>
<rejected>0.000000</rejected>
<approved>3.000000</approved>
<returned>0.000000</returned>
<orders>0.000000</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
<average_macro_event_conversion_score>83.000000</average_macro_event_conversion_score>
<paid_micro_events>0.000000</paid_micro_events>
<total_paid>3.000000</total_paid>
</sub_id_summary>
</sub_ids>
</sub_id_summary_response>

 


Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired.