[Reports] CampaignSummary (V5) - Affiliate

WSDL Page: http://<your_domain_here>/affiliates/api/5/reports.asmx?op=CampaignSummary

Parameter Summary:

api_key / STRING = Affiliate API Key {See auth.asmx > Login}

affiliate_id / INT = Affiliate ID {See auth.asmx > Login}

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

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

sub_affiliate / STRING = SubAffiliate Name

conversion_type / STRING = The type of conversion ["all", "events", "conversions"]

start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]

row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]

sort_field / STRING = Sort Field ["offer_id", "offer_name", "vertical_name", "price_format", "price", "impressions", "clicks", "conversions", "conversion_rate", "revenue", "epc"]

sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]

Parameter Types:

api_key - ID

affiliate_id - ID

start_date - ID

end_date - ID

sub_affiliate - ID

conversion_type - ASSIGNABLE

start_at_row - ASSIGNABLE

row_limit - ASSIGNABLE

sort_field - ASSIGNABLE

sort_descending - ASSIGNABLE

Sample GET Call: 

https://demo.cakemarketing.com/affiliates/api/5/reports.asmx/CampaignSummary?api_key=LRKjY66p5iQz1WTtPMy6Q&affiliate_id=2699&start_date=01/01/2013+00:00:00&end_date=07/01/2013+01:00:00&sub_affiliate=&conversion_type=all&start_at_row=1&row_limit=3&sort_field=offer_id&sort_descending=FALSE

Sample XML Response:

<campaign_summary_response>

    <success>true</success>
    <row_count>3</row_count>
    <summary>
        <clicks>1621</clicks>
        <conversions>12</conversions>
        <conversion_rate>0.007402837754472547809993831</conversion_rate>
        <revenue>210.000000</revenue>
        <revenue_converted>210.000000</revenue_converted>
        <currency_symbol>£</currency_symbol>
        <currency_symbol_converted>£</currency_symbol_converted>
        <events>0</events>
    </summary>
    <campaigns>
        <campaign>
            <offer_id>100</offer_id>
            <offer_name>AppTastic - Wendys 1st Page - othername</offer_name>
            <campaign_id>997</campaign_id>
            <vertical_name>Marketing Technology</vertical_name>
            <price_format>CPA</price_format>
            <price>0.0000</price>
            <impressions>0</impressions>
            <clicks>1619</clicks>
            <conversions>0</conversions>
            <conversion_rate>0.000000</conversion_rate>
            <revenue>0.0000</revenue>
            <revenue_converted>0.000000</revenue_converted>
            <epc>0.00000000000000000</epc>
            <currency_symbol>€</currency_symbol>
            <currency_symbol_converted>£</currency_symbol_converted>
            <events>0</events>
        </campaign>
        <campaign>
            <offer_id>1000000</offer_id>
            <offer_name>Apple Ipad 2- AU - Wendys Zip Submit</offer_name>
            <campaign_id>3006</campaign_id>
            <vertical_name>Marketing Technology</vertical_name>
            <price_format>CPA</price_format>
            <price>18.0000</price>
            <impressions>0</impressions>
            <clicks>0</clicks>
            <conversions>10</conversions>
            <conversion_rate>0.000000</conversion_rate>
            <revenue>180.0000</revenue>
            <revenue_converted>180.000000</revenue_converted>
            <epc>0.00000000000000000</epc>
            <currency_symbol>$</currency_symbol>
            <currency_symbol_converted>£</currency_symbol_converted>
            <events>0</events>
        </campaign>

</campaign_summary_response>