REPORTS CampaignSummary API Version 5

Luke Kadillak

Modified on: Mon, 9 Oct, 2023 at 9:53 AM

REPORTS CampaignSummary API Version 5

Updated on 2016-02-09
Current Version: Version 5
Requests Allowed: HTTP GET / HTTP POST / SOAP 1.1 / SOAP 1.2

Summary:

Performance summary based on campaign.

Report can also be generated within CAKE from the Reports tab - Master Campaign report.

Resource/WSDL Page:

http://api/5/reports.asmx?op=CampaignSummary

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
campaign_id Required Value Type: INT	Obtained via EXPORT Campaigns API. Pass 0 for all Example Values: 159
source_affiliate_id Required Value Type: INT	Obtained via EXPORT Affiliates API. Pass 0 for all Example Values: 1267
subid_id Required Value Type: STRING	Obtained via EXPORT Affiliates API. Leave blank for all Example Values: 1267abd3
site_offer_id Required Value Type: INT	Obtained via EXPORT Offers API. Pass 0 for all Example Values: 1289
source_affiliate_tag_id Required Value Type: INT	Obtained via GET AffiliateTags API. Pass 0 for all Example Values: 28
site_offer_tag_id Required Value Type: INT	Obtained via EXPORT Offers API. Pass 0 for all Example Values: 44
source_affiliate_manager_id Required Value Type: INT	Obtained via EXPORT Affiliates API. Pass 0 for all Example Values: 87
brand_advertiser_manager_id Required Value Type: INT	Obtained via EXPORT Advertisers API. Pass 0 for all Example Values: 87
event_id Required Value Type: INT	Obtained via EXPORT Offers API. Pass 0 for all Example Values: 4
event_type Required Value Type: ENUMERATION	Filter based on how revenue was generated (events, conversions or both) Example Values: all or macro_event_conversions or micro_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

https://demo-new.cakemarketing.com/api/5/reports.asmx/CampaignSummary?api_key=3YmDJeT3VHTFhDqAjr2OlQ&start_date=01-01-2016%20&end_date=01-31-2016%20&campaign_id=0%20&source_affiliate_id=1111667%20&subid_id=%20&site_offer_id=0%20&source_affiliate_tag_id=0%20&site_offer_tag_id=0%20&source_affiliate_manager_id=0%20&brand_advertiser_manager_id=0%20&event_id=0%20&event_type=macro_event_conversions

Sample XML Response:

<campaign_summary_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/5/">
<success>true</success>
<row_count>2</row_count>
<campaigns>
<campaign_summary>
<campaign>
<campaign_id xmlns="API:id_name_store">30881</campaign_id>
<campaign_name xmlns="API:id_name_store">Google</campaign_name>
</campaign>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">1111667</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">Tim's Affiliate 2</source_affiliate_name>
</source_affiliate>
<site_offer>
<site_offer_id xmlns="API:id_name_store">55378734</site_offer_id>
<site_offer_name xmlns="API:id_name_store">Tim's Offer - CPA Step 1</site_offer_name>
</site_offer>
<brand_advertiser>
<brand_advertiser_id xmlns="API:id_name_store">900709</brand_advertiser_id>
<brand_advertiser_name xmlns="API:id_name_store">Tim's Advertiser</brand_advertiser_name>
</brand_advertiser>
<source_affiliate_manager>
<account_manager_id xmlns="API:id_name_store">3505</account_manager_id>
<account_manager_name xmlns="API:id_name_store">Admin User</account_manager_name>
</source_affiliate_manager>
<brand_advertiser_manager>
<account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
<account_manager_name xmlns="API:id_name_store">Mog Kupo</account_manager_name>
</brand_advertiser_manager>
<price_format>CPA</price_format>
<media_type>Banner</media_type>
<views>0</views>
<clicks>3</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<macro_event_conversions>0.000000</macro_event_conversions>
<paid>0.000000</paid>
<sellable>0.000000</sellable>
<micro_events>0.000000</micro_events>
<macro_event_conversion_percentage>0.000000</macro_event_conversion_percentage>
<cost>0.0000</cost>
<average_cost>0.000000</average_cost>
<epc>0.000000</epc>
<revenue>0.0000</revenue>
<revenue_per_transaction>0.000000</revenue_per_transaction>
<margin>0.0000</margin>
<profit>0.0000</profit>
<pending>0.000000</pending>
<rejected>0.000000</rejected>
<approved>0.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>0.000000</total_paid>
</campaign_summary>
<campaign_summary>
<campaign>
<campaign_id xmlns="API:id_name_store">569631</campaign_id>
</campaign>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">1111667</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">Tim's Affiliate 2</source_affiliate_name>
</source_affiliate>
<site_offer>
<site_offer_id xmlns="API:id_name_store">55378899</site_offer_id>
<site_offer_name xmlns="API:id_name_store">Tim's Offer Events Campaign Test</site_offer_name>
</site_offer>
<brand_advertiser>
<brand_advertiser_id xmlns="API:id_name_store">900709</brand_advertiser_id>
<brand_advertiser_name xmlns="API:id_name_store">Tim's Advertiser</brand_advertiser_name>
</brand_advertiser>
<source_affiliate_manager>
<account_manager_id xmlns="API:id_name_store">3505</account_manager_id>
<account_manager_name xmlns="API:id_name_store">Admin User</account_manager_name>
</source_affiliate_manager>
<brand_advertiser_manager>
<account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
<account_manager_name xmlns="API:id_name_store">Mog Kupo</account_manager_name>
</brand_advertiser_manager>
<price_format>CPA</price_format>
<media_type>Banner</media_type>
<views>0</views>
<clicks>4</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<macro_event_conversions>4.000000</macro_event_conversions>
<paid>4.000000</paid>
<sellable>4.000000</sellable>
<micro_events>0.000000</micro_events>
<macro_event_conversion_percentage>100.000000</macro_event_conversion_percentage>
<cost>100.0000</cost>
<average_cost>25.000000</average_cost>
<epc>25.000000</epc>
<revenue>200.0000</revenue>
<revenue_per_transaction>50.000000</revenue_per_transaction>
<margin>50.0000</margin>
<profit>100.0000</profit>
<pending>0.000000</pending>
<rejected>0.000000</rejected>
<approved>4.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>4.000000</total_paid>
</campaign_summary>
</campaigns>
</campaign_summary_response>

Example Error Messages:

Error Message	Likely Cause
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.

REPORTS CampaignSummary API Version 5

Summary:

Resource/WSDL Page:

Parameters

**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

Related Articles