REPORTS CampaignSummary API Version 2

Ron Torres

Modified on: Tue, 9 Feb, 2016 at 12:54 PM

REPORTS CampaignSummary API Version 2

Updated on 2014-04-02
Current Version: Version 2
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/2/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. Example Values: MM/DD/YYYY, hh:mm:ss, YYYY-MM-DD hh:mm:ss **You can only pull one month increments maximum
affiliate_id Required Value Type: INT	Filter to reduce report to only a specific affiliate. Obtained via EXPORT Affiliates API Example Values: 159
affiliate_tag_id Required Value Type: INT	Filter to reduce report to only affiliates with a specific tag. Obtained via GET AffiliateTags API Example Values: ID obtained from the Affiliate card in Cake or through other APIs.
offer_id Required Value Type: INT	Filter to reduce report to only a specific offer. You CANNOT use the wildcard value of "0" here to pull back ALL offers. Obtained via EXPORT Offers API Example Values: ID obtained from the Offer card in Cake or through other APIs.
offer_tag_id Required Value Type: INT	Filter to reduce report to only offers with a specific tag. Obtained via EXPORT Offers API Example Values: ID obtained from the Offer card in Cake or through other APIs.
campaign_id Required Value Type: INT	Filter to reduce report to only a specific campaign. Obtained via EXPORT Campaigns API Example Values: ID obtained from the Campaign card in Cake or through other APIs.
event_id Required Value Type: INT	Filter to reduce report to only a specific event. Example Values: Obtained through other APIs.
revenue_filter Required Value Type: STRING	Filter based on how revenue was generated (events, conversions or both) Example Values: conversions_and_events, conversions, 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/CampaignSummary?api_key=rYwtD48irQ0CiHRiuaB9abASO3e8O7GS&start_date=01-01-2015&end_date=01-30-2015&affiliate_id=0&affiliate_tag_id=0&offer_tag_id=0&event_id=0&revenue_filter=conversions_and_events&offer_id=55378321&campaign_id=0

Sample XML Response:

<campaign_summary_response>
<success>true</success>
<row_count>1</row_count>
<campaigns>
    <campaign_summary>
      <campaign>
        <campaign_id>26675</campaign_id>
      </campaign>
      <affiliate>
        <affiliate_id>1111298</affiliate_id>
        <affiliate_name>Eric's Affiliate</affiliate_name>
      </affiliate>
      <offer>
        <offer_id>1002284</offer_id>
        <offer_name>Single Opt-in</offer_name>
      </offer>
      <account_manager>
        <account_manager_id>3615</account_manager_id>
        <account_manager_name>Eric Admin</account_manager_name>
      </account_manager>
      <advertiser>
        <advertiser_id>288</advertiser_id>
        <advertiser_name>Eric's Advertiser</advertiser_name>
      </advertiser>
      <advertiser_manager>
        <account_manager_id>1120</account_manager_id>
        <account_manager_name>John Doe</account_manager_name>
      </advertiser_manager>
      <price_format>CPA</price_format>
      <media_type>Adware</media_type>
      <views>0</views>
      <clicks>1</clicks>
      <click_thru_percentage>0.000000</click_thru_percentage>
      <conversions>1</conversions>
      <paid>1</paid>
      <sellable>1</sellable>
      <events>1</events>
      <conversion_percentage>100.000000</conversion_percentage>
      <cost>15.0000</cost>
      <average_cost>15.000000</average_cost>
      <epc>15.000000</epc>
      <revenue>10.0000</revenue>
      <revenue_per_transaction>10.000000</revenue_per_transaction>
      <margin>-50.0000</margin>
      <profit>-5.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"/>
    </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.