Note: This API requires a Offer ID, or a Campaign ID to be passed on the request. This API will only allow a 30 day span to be requested. If you request a longer period of time then the API call will error.

 

WSDL Page:  http://<your_domain_here>/api/2/reports.asmx?op=CreativeSummary

 

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

start_date / DATETIME = Report Start Date [MM/DD/YYYY HH:MM:SS]

end_date / DATETIME = Report End Date [MM/DD/YYYY HH:MM:SS]

offer_id / ID = Offer ID from the system {See export.asmx > Offers}

campaign_id / ID = Campaign ID to be used as a filter. {See export.asmx > Campaigns}

event_id / ID = Event filter, pass the ID of the event to filter the results. ["0" to ignore]

revenue_filter / ENUM = Filter the revenue by the event type ["conversions_and_events" or "conversions" or "events"]

 

Parameter Types:

api_key - ID

start_date - DATETIME

end_date - DATETIME

offer_id - ID

campaign_id - ID

event_id - ID

revenue_filter - ENUM

 

Sample GET Call:

http://demo.cakemarketing.com/api/2/reports.asmx/CreativeSummary?api_key=dNJFmId9rI&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>