Submit a Ticket My Tickets
Welcome
Login  Sign up
  1. CAKE
  2. Solution home
  3. Our API
  4. ARCHIVED - API Docs (Old Format)

DEPRECATED - [Reports] Clicks (V4) - Admin

Ron Torres
Modified on: Fri, 18 Sep, 2015 at 4:24 PM

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:///api/4/reports.asmx?op=Clicks

 

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

advertiser_id / INT = Advertiser ID ["0" = ALL Advertisers] {See export.asmx > Advertisers}

offer_id / INT = Offer ID ["0" = ALL Offers] {See export.asmx > Offers}

campaign_id / INT = Campaign ID ["0" = ALL Campaigns] {See export.asmx > Campaigns}

creative_id / INT = Creative ID ["0" = ALL Creatives] {See export.asmx > Creatives}

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

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]

 

Parameter Types:

api_key - ID

start_date - ID

end_date - ID

affiliate_id - ID

advertiser_id - ID

offer_id - ID

campaign_id - ID

creative_id - ID

include_tests - ID

start_at_row - ID

row_limit - ID

 

Sample GET Call:

http://demo.cakemarketing.com/api/4/reports.asmx/Clicks?api_key=dNJFmId9rI&start_date=01/01/2012+12:00:00&end_date=01/02/2012+12:00:00&affiliate_id=4410&advertiser_id=0&offer_id=0&campaign_id=0&creative_id=0&include_tests=TRUE&start_at_row=1&row_limit=5

 

Sample XML Response:

<click_report_response>
  <success>true</success>
  <row_count>5</row_count>
  <clicks>
    <click>
      <click_id>305777</click_id>
      <visitor_id>1281728</visitor_id>
      <request_session_id>292990</request_session_id>
      <click_date>2012-01-01T12:00:41.25</click_date>
      <affiliate>
        <affiliate_id>4410</affiliate_id>
        <affiliate_name>Affilate 4410</affiliate_name>
      </affiliate>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>-1</offer_id>
        <offer_name>Offer -1</offer_name>
      </offer>
      <campaign_id>-1</campaign_id>
      <creative>
        <creative_id>326</creative_id>
        <creative_name>326 - Best Creative</creative_name>
      </creative>
      <sub_id_1>594</sub_id_1>
      <sub_id_2>slava021209</sub_id_2>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <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>
      <referrer_url/>
      <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>
      <visitor_id>1281755</visitor_id>
      <request_session_id>293017</request_session_id>
      <click_date>2012-01-01T12:14:36.667</click_date>
      <affiliate>
        <affiliate_id>4410</affiliate_id>
        <affiliate_name>Affilate 4410</affiliate_name>
      </affiliate>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>163</offer_id>
        <offer_name>WALMART Gift Card - UK</offer_name>
      </offer>
      <campaign_id>1010</campaign_id>
      <creative>
        <creative_id>326</creative_id>
        <creative_name>326 - Best Creative</creative_name>
      </creative>
      <sub_id_1>1430</sub_id_1>
      <sub_id_2/>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <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>
      <referrer_url/>
      <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
      <redirect_url>http://www.cakemarketing.com</redirect_url>
      <disposition/>
      <total_clicks>1</total_clicks>
    </click>
    <click>
      <click_id>305825</click_id>
      <visitor_id>1281771</visitor_id>
      <request_session_id>293034</request_session_id>
      <click_date>2012-01-01T12:24:17.427</click_date>
      <affiliate>
        <affiliate_id>4410</affiliate_id>
        <affiliate_name>Affilate 4410</affiliate_name>
      </affiliate>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>163</offer_id>
        <offer_name>WALMART Gift Card - UK</offer_name>
      </offer>
      <campaign_id>1010</campaign_id>
      <creative>
        <creative_id>326</creative_id>
        <creative_name>326 - Best Creative</creative_name>
      </creative>
      <sub_id_1>36</sub_id_1>
      <sub_id_2/>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <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>
      <referrer_url/>
      <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
      <redirect_url>http://www.cakemarketing.com</redirect_url>
      <disposition/>
      <total_clicks>1</total_clicks>
    </click>
    <click>
      <click_id>305826</click_id>
      <visitor_id>1281772</visitor_id>
      <request_session_id>293035</request_session_id>
      <click_date>2012-01-01T12:24:17.52</click_date>
      <affiliate>
        <affiliate_id>4410</affiliate_id>
        <affiliate_name>Affilate 4410</affiliate_name>
      </affiliate>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>163</offer_id>
        <offer_name>WALMART Gift Card - UK</offer_name>
      </offer>
      <campaign_id>1010</campaign_id>
      <creative>
        <creative_id>326</creative_id>
        <creative_name>326 - Best Creative</creative_name>
      </creative>
      <sub_id_1>36</sub_id_1>
      <sub_id_2/>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <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>
      <referrer_url/>
      <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
      <redirect_url>http://www.cakemarketing.com</redirect_url>
      <disposition/>
      <total_clicks>2</total_clicks>
    </click>
    <click>
      <click_id>305902</click_id>
      <visitor_id>1281840</visitor_id>
      <request_session_id>293103</request_session_id>
      <click_date>2012-01-01T13:19:17.313</click_date>
      <affiliate>
        <affiliate_id>4410</affiliate_id>
        <affiliate_name>Affilate 4410</affiliate_name>
      </affiliate>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>163</offer_id>
        <offer_name>WALMART Gift Card - UK</offer_name>
      </offer>
      <campaign_id>1010</campaign_id>
      <creative>
        <creative_id>326</creative_id>
        <creative_name>326 - Best Creative</creative_name>
      </creative>
      <sub_id_1>2515</sub_id_1>
      <sub_id_2>HM1204</sub_id_2>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <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>
      <referrer_url/>
      <request_url>http://caketrk.com/?a=40&c=282&s1=51447</request_url>
      <redirect_url>http://www.cakemarketing.com</redirect_url>
      <disposition/>
      <total_clicks>1</total_clicks>
    </click>
  </clicks>
</click_report_response>

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles