NOTICE:  THIS VERSION OF THE API HAS BEEN DEPRECATED.  IT WILL CONTINUE TO WORK INDEFINITELY, BUT HAS INCREASED FUNCTIONALITY IN NEWER VERSIONS.

 

WSDL Page:  http://your-admin-domain-here.com/api/1/reports.asmx?op=ClickExport

 

Parameter Summary:

api_key / STRING = Admin API Key {Found in Setup maintab > Permissions subtab > API Keys}

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 / INT = Affiliate ID ["0" = ALL Affiliates] {See EXPORT Affiliates}

offer_id / INT = Offer ID ["0" = ALL Offers] {See EXPORT Offers}

include_tests / BOOL = Include Test Clicks? ["TRUE", "FALSE"]

 

Parameter Types:

api_key - ID

start_date - ID

end_date - ID

affiliate_id - ID

offer_id - ID

include_tests - ID

 

Sample GET Call:

http://demo.cakemarketing.com/api/1/reports.asmx/ClickExport?api_key=dNJFmId9rI&start_date=01/01/2012+12:00:00&end_date=01/01/2012+17:00:00&affiliate_id=4410&offer_id=0&include_tests=TRUE

 

Sample XML Response:

<ArrayOfClick>
  <Click>
    <click_id>305777</click_id>
    <request_session_id>292990</request_session_id>
    <click_date>2012-01-01T12:00:41.25</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>-1</offer_id>
    <offer_name>Offer -1</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>-1</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>594</subid_1>
    <subid_2>slava021209</subid_2>
    <ip_address>192.168.1.1</ip_address>
    <country>CA</country>
    <user_agent>Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.1.2) Gecko/20090729 Firefox/3.5.2 GTB6 (.NET CLR 3.5.30729)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <disposition>Geotarget Mismatch</disposition>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>305807</click_id>
    <request_session_id>293017</request_session_id>
    <click_date>2012-01-01T12:14:36.667</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>1430</subid_1>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.0.16) Gecko/2009120208 Firefox/3.0.16 GTB6 (.NET CLR 3.5.30729)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>305825</click_id>
    <request_session_id>293034</request_session_id>
    <click_date>2012-01-01T12:24:17.427</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>36</subid_1>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/5.0 (compatible; Yahoo! Slurp/3.0; http://help.yahoo.com/help/us/ysearch/slurp)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>305826</click_id>
    <request_session_id>293035</request_session_id>
    <click_date>2012-01-01T12:24:17.52</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>36</subid_1>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/5.0 (compatible; Yahoo! Slurp/3.0; http://help.yahoo.com/help/us/ysearch/slurp)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>2</total_clicks>
  </Click>
  <Click>
    <click_id>305902</click_id>
    <request_session_id>293103</request_session_id>
    <click_date>2012-01-01T13:19:17.313</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>2515</subid_1>
    <subid_2>HM1204</subid_2>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; WOW64; Trident/4.0; GTB6.3; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; InfoPath.2; OfficeLiveConnector.1.4; OfficeLivePatch.1.3)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>305918</click_id>
    <request_session_id>293118</request_session_id>
    <click_date>2012-01-01T13:32:22.807</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>37</subid_1>
    <subid_2>x3three</subid_2>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; FunWebProducts; FBSMTWB; GTB6.3; .NET CLR 1.0.3705; .NET CLR 1.1.4322; Media Center PC 4.0; .NET CLR 2.0.50727; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729; WinNT-PAI 03.07.2009; yie8)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>305972</click_id>
    <request_session_id>293173</request_session_id>
    <click_date>2012-01-01T14:13:25.793</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>1343</subid_1>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; .NET CLR 3.5.30729; .NET CLR 3.0.30618)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>305982</click_id>
    <request_session_id>293182</request_session_id>
    <click_date>2012-01-01T14:17:45.38</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>2196</subid_1>
    <subid_2>fn120309</subid_2>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; WOW64; Trident/4.0; FunWebProducts; GTB6.3; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; .NET CLR 3.5.21022; .NET CLR 3.5.30729; .NET CLR 3.0.30618; msn OptimizedIE8;ENUS)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>306021</click_id>
    <request_session_id>293217</request_session_id>
    <click_date>2012-01-01T14:37:58.88</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>546</subid_1>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; GTB6; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>306095</click_id>
    <request_session_id>293286</request_session_id>
    <click_date>2012-01-01T15:18:42.17</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>462</subid_1>
    <subid_2>45441_</subid_2>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; WOW64; Trident/4.0; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; eSobiSubscriber 2.0.4.16; .NET CLR 3.5.30729; .NET CLR 3.0.30618)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <paid_action>4CD4578B</paid_action>
    <total_clicks>1</total_clicks>
  </Click>
  <Click>
    <click_id>306242</click_id>
    <request_session_id>293424</request_session_id>
    <click_date>2012-01-01T16:45:56.143</click_date>
    <affiliate_id>4410</affiliate_id>
    <affiliate_name>Affilate 4410</affiliate_name>
    <offer_id>163</offer_id>
    <offer_name>WALMART Gift Card - UK</offer_name>
    <advertiser_id>1</advertiser_id>
    <advertiser_name>Rename Advertiser</advertiser_name>
    <campaign_id>1010</campaign_id>
    <creative_id>326</creative_id>
    <creative_name>326 - Best Creative</creative_name>
    <subid_1>1343</subid_1>
    <ip_address>192.168.1.1</ip_address>
    <country>US</country>
    <user_agent>Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.1.6) Gecko/20091201 YFF35 Firefox/3.5.6 (.NET CLR 3.5.30729)</user_agent>
    <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
    <redirect_url>http://www.cakemarketing.com</redirect_url>
    <total_clicks>1</total_clicks>
  </Click>
</ArrayOfClick>