[REPORTS] AffiliateSummary (V2) - Admin

Ron Torres

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

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

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]

affiliate_id / ID = Affiliate ID {See export.asmx > Affiliates}

affiliate_manager_id / ID = The contact ID who manages the Affiliate. Used to filter response. {See export.asmx > Affiliates}

affiliate_tag_id / ID = Offer Tag ID from the system {See export.asmx > Affiliates}

offer_tag_id / ID = Offer ID to be used as a filter. {See export.asmx > Offers}

event_id / ID = Event filter, pass the ID of the event to filter the results

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

affiliate_id - ID

affiliate_manager_id- ID

affiliate_tag_id - ID

offer_tag_id - ID

event_id - ID

revenue_filter - ENUM

Sample GET Call:

http://demo.cakemarketing.com/api/2/reports.asmx/AffiliateSummary?api_key=dNJFmId9rI&start_date=2%2F19%2F2014&end_date=2%2F20%2F2014&affiliate_id=1111298&affiliate_manager_id=0&affiliate_tag_id=0&offer_tag_id=0&event_id=0&revenue_filter=conversions_and_events

Sample XML Response:

<affiliate_summary_response>
<success>true</success>
<row_count>1</row_count>
<affiliates>
    <affiliate_summary>
      <affiliate>
        <affiliate_id>1111298</affiliate_id>
        <affiliate_name>Eric's Affiliate</affiliate_name>
      </affiliate>
      <account_manager>
        <account_manager_id>3615</account_manager_id>
        <account_manager_name>Eric Admin</account_manager_name>
      </account_manager>
      <views>0</views>
      <clicks>2</clicks>
      <click_thru_percentage>0.000000</click_thru_percentage>
      <conversions>1</conversions>
      <paid>1</paid>
      <sellable>1</sellable>
      <events>1</events>
      <conversion_percentage>50.000000</conversion_percentage>
      <cost>15.0000</cost>
      <average_cost>15.000000</average_cost>
      <epc>7.500000</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"/>
    </affiliate_summary>
</affiliates>
</affiliate_summary_response>

Related Articles