[REPORTS] OfferSummary (V2) - Admin

Ron Torres

Modified on: Wed, 9 Sep, 2015 at 11:12 AM

WSDL Page: http://yourdomainhere/api/2/reports.asmx?op=OfferSummary

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]

advertiser_id / ID = Advertiser ID {See export.asmx > Advertiser}

advertiser_manager_id / ID = Contact ID from the system {See export.asmx > Advertiser}

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

offer_tag_id / ID = The tag ID of the Offer. To be used as a filter. {See export.asmx > Offers }

affiliate_tag_id / ID = The tag ID of the Affiliate. To be used as a filter. {See export.asmx > Affiliates}

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

advertiser_id - ID

advertiser_manager_id - ID

offer_id - ID

offer_tag_id - ID

affiliate_tag_id - ID

event_id - ID

revenue_filter - ENUM

Sample GET Call:

http://demo.cakemarketing.com/api/2/reports.asmx/OfferSummary?api_key=dNJFmId9rI&start_date=2%2F19%2F2014&end_date=2%2F20%2F2014&advertiser_id=0&advertiser_manager_id=0&offer_id=10&offer_tag_id=0&affiliate_tag_id=0&event_id=0&revenue_filter=conversions_and_events

Sample XML Response:

<advertiser_name xmlns="API:id_name_store">7</advertiser_name>
</advertiser>
<account_manager>
    <account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
    <account_manager_name xmlns="API:id_name_store">John Doe</account_manager_name>
</account_manager>
<views>0</views>
<clicks>0</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<conversions>1</conversions>
<paid>0</paid>
<sellable>1</sellable>
<events>0</events>
<conversion_percentage>0.000000</conversion_percentage>
<cost>0.0000</cost>
<average_cost>0.000000</average_cost>
<epc>0.000000</epc>
<revenue>35.0000</revenue>
<revenue_per_transaction>35.000000</revenue_per_transaction>
<margin>100.0000</margin>
<profit>35.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"/>
</offer_summary>
<offer_summary>
<offer>
    <offer_id xmlns="API:id_name_store">1001628</offer_id>
    <offer_name xmlns="API:id_name_store">Brads Example Hosted no received</offer_name>
</offer>
<advertiser>
    <advertiser_id xmlns="API:id_name_store">900049</advertiser_id>
    <advertiser_name xmlns="API:id_name_store">24option.com</advertiser_name>
</advertiser>
<account_manager>
    <account_manager_id xmlns="API:id_name_store">3523</account_manager_id>
    <account_manager_name xmlns="API:id_name_store">boo radley</account_manager_name>
</account_manager>
<views>0</views>
<clicks>0</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<conversions>4</conversions>
<paid>0</paid>
<sellable>4</sellable>
<events>0</events>
<conversion_percentage>0.000000</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</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"/>
</offer_summary>
<offer_summary>
<offer>
    <offer_id xmlns="API:id_name_store">1002061</offer_id>
    <offer_name xmlns="API:id_name_store">[UK test] Capital option</offer_name>
</offer>
<advertiser>
    <advertiser_id xmlns="API:id_name_store">900171</advertiser_id>
    <advertiser_name xmlns="API:id_name_store">[UK test] Advertiser</advertiser_name>
</advertiser>
<account_manager>
    <account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
    <account_manager_name xmlns="API:id_name_store">John Doe</account_manager_name>
</account_manager>
<views>0</views>
<clicks>4</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<conversions>2</conversions>
<paid>2</paid>
<sellable>2</sellable>
<events>0</events>
<conversion_percentage>50.000000</conversion_percentage>
<cost>13.5904</cost>
<average_cost>6.795200</average_cost>
<epc>3.397600</epc>
<revenue>27.1807</revenue>
<revenue_per_transaction>13.590350</revenue_per_transaction>
<margin>49.9900</margin>
<profit>13.5903</profit>
<pending>0</pending>
<rejected>0</rejected>
<approved>2</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"/>
</offer_summary>
<offer_summary>
<offer>
    <offer_id xmlns="API:id_name_store">1002210</offer_id>
    <offer_name xmlns="API:id_name_store">Carlee Event</offer_name>
</offer>
<advertiser>
    <advertiser_id xmlns="API:id_name_store">900001</advertiser_id>
    <advertiser_name xmlns="API:id_name_store">Carlee Advertiser</advertiser_name>
</advertiser>
<account_manager>
    <account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
    <account_manager_name xmlns="API:id_name_store">John Doe</account_manager_name>
</account_manager>
<views>0</views>
<clicks>1</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<conversions>0</conversions>
<paid>0</paid>
<sellable>0</sellable>
<events>0</events>
<conversion_percentage>0.000000</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</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"/>
</offer_summary>
<offer_summary>
<offer>
    <offer_id xmlns="API:id_name_store">1002284</offer_id>
    <offer_name xmlns="API:id_name_store">Single Opt-in</offer_name>
</offer>
<advertiser>
    <advertiser_id xmlns="API:id_name_store">288</advertiser_id>
    <advertiser_name xmlns="API:id_name_store">Eric's Advertiser</advertiser_name>
</advertiser>
<account_manager>
    <account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
    <account_manager_name xmlns="API:id_name_store">John Doe</account_manager_name>
</account_manager>
<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"/>
</offer_summary>
<offer_summary>
<offer>
    <offer_id xmlns="API:id_name_store">1002285</offer_id>
    <offer_name xmlns="API:id_name_store">Double Optin</offer_name>
</offer>
<advertiser>
    <advertiser_id xmlns="API:id_name_store">288</advertiser_id>
    <advertiser_name xmlns="API:id_name_store">Eric's Advertiser</advertiser_name>
</advertiser>
<account_manager>
    <account_manager_id xmlns="API:id_name_store">1120</account_manager_id>
    <account_manager_name xmlns="API:id_name_store">John Doe</account_manager_name>
</account_manager>
<views>0</views>
<clicks>1</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<conversions>0</conversions>
<paid>0</paid>
<sellable>0</sellable>
<events>0</events>
<conversion_percentage>0.000000</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</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"/>
</offer_summary>
</offers>
</offer_summary_report_response>

Related Articles