REPORTS CreativeSummary API Version 2

Luke Kadillak

Modified on: Thu, 22 Jun, 2023 at 11:26 AM

REPORTS CreativeSummary API

Updated on 2014-03-31
Current Version: Version 2
Deprecated Version:
Requests Allowed: GET&SOAP

Summary:

Returns an array of conversion and their properties.

Resource/WSDL Page:

http://yourdomainhere/api/2/reports.asmx?op=CreativeSummary

Parameters

api_key Required Type: STRING Length (Max/Min): 50	Must be a valid API key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aVMhh
start_date Required Type: DATE Length (Max/Min): NA	Allowed formats: "YYYY-mm-dd", "dd-mm-YYYY" Example Values: 2014-04-24, 24-04-2014
end_date Required Type: DATE Length (Max/Min): NA	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: 2014-04-24, 24-04-2014
offer_id Required Type: INT Length (Max/Min): NA	Offer filter, pass the ID of the offer to filter the results. Example Values: 12356
campaign_id Required Type: INT Length (Max/Min): NA	If passing anything <= 0 the result will include all campaigns for the offer being filtered. Example Values: 123456
event_id Required Type: INT Length (Max/Min): NA	Event filter, pass the ID of the event to filter the results. ["0" to ignore] Example Values: 123456
revenue_filter Required Type: STRING Length (Max/Min): NA	Filter the revenue by the event type ["conversions_and_events" or "conversions" or "events"] Example Values: conversions

**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/2/reports.asmx/CreativeSummary?api_key=3YmDJeT3VHTFhDqAjr2OlQ&start_date=2%2F19%2F2014&end_date=2%2F20%2F2014&offer_id=0&campaign_id=26675&event_id=0&revenue_filter=conversions_and_events

Sample XML Response:

<creative_summary_response>
<success>true</success>
<row_count>1</row_count>
<creatives>
<creative_summary>
<creative>
<creative_id>1135267</creative_id>
<creative_name>1135267</creative_name>
</creative>
<creative_affiliate_id xsi:nil="true"/>
<type>Link</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>
</creative_summary>
</creatives>
</creative_summary_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired
Date Range Too Long	Date Range is greater than 31 days
Invalid Offer ID	Offer requested does not exist