REPORTS Conversions API Version 8 (DEPRECATED)

api_key
Required
Type: STRING
Length (Max/Min): 50

This api_key will provide you with the ability to export Clicks for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.

Example Value: 

Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

start_date
Required
Type: DATETIME
Length (Max/Min): N/A

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

Example Values: 12/31/2013 15:16:17

end_date
Required
Type: DATETIME
Length (Max/Min): N/A

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

Example Values: 12/31/2013 15:16:17

affiliate_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Affiliate.  This can be found on any Affiliate card.

Example Values: 1234

advertiser_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Advertiser.  This can be found on any Affiliate card.

Example Values: 1234

offer_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Offer.  This can be found on any Offer card.

Example Values: 1234

campaign_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique campaign. You can obtain the campaign ID from your CAKE instance on the campaign card. To get there, go to the advertiser tab >> offers >> choose an offer to open the offer card >> campaign tab >> choose a campaign >> ID. 

Example Values: 1234

creative_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique creative. You can obtain the creative ID from your CAKE instance on the offer card. To get there, go to the advertiser tab >> offers >> choose an offer to open the offer card >> creatives tab >> choose a creative >> ID. 

Example Values: 1234

include_tests
Required
Type: BOOL
Length (Max/Min): N/A

The following values can only be used for this parameter (TRUE or FALSE).

Example Values: TRUE

start_at_row
Required
Type: INTEGER
Length (Max/Min): N/A

Must pass at least 0 as value, which means start at the beginning of the data set.

Example Values: 3

row_limit
Required
Type: INTEGER
Length (Max/Min): N/A

Must pass at least 0 as value, which means no limit.

Example Values: 3

sort_field
Required
Type: STRING
Length (Max/Min): N/A

Accepts "conversion_id", "visitor_id", "request_session_id", "click_id", "conversion_date", "transaction_id", "last_updated"

Example Values: conversion_id

sort_descending
Required
Type: BOOL
Length (Max/Min): N/A

The following values can only be used for this parameter (TRUE or FALSE).

Example Values: TRUE

GET

<conversion_report_response>
  <success>true</success>
  <row_count>1</row_count>
  <conversions>
    <conversion>
      <conversion_id>4CD4578B</conversion_id>
      <visitor_id>1282015</visitor_id>
      <request_session_id>293286</request_session_id>
      <click_request_session_id>293286</click_request_session_id>
      <click_id>306095</click_id>
      <conversion_date>2012-01-01T15:19:56.02</conversion_date>
      <last_updated>2013-01-23T20:53:56.547</last_updated>
      <click_date>2012-01-01T15:18:42.17</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>462</sub_id_1>
      <sub_id_2>45441_</sub_id_2>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <conversion_type>CPA</conversion_type>
      <paid>
        <currency_id>2</currency_id>
        <amount>15.0000</amount>
        <formatted_amount>€15.00</formatted_amount>
      </paid>
      <received>
        <currency_id>2</currency_id>
        <amount>21.7500</amount>
        <formatted_amount>€21.75</formatted_amount>
      </received>
      <step_reached>1</step_reached>
      <pixel_dropped>true</pixel_dropped>
      <suppressed>false</suppressed>
      <returned>false</returned>
      <test>false</test>
      <transaction_id/>
      <conversion_ip_address>168.192.1.1</conversion_ip_address>
      <click_ip_address>192.168.1.1</click_ip_address>
      <conversion_referrer_url/>
      <conversion_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)</conversion_user_agent>
      <click_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)</click_user_agent>
      <country>
        <country_code>US</country_code>
      </country>
      <current_disposition>
        <disposition_id>53</disposition_id>
        <disposition_name>Generic Voicemail</disposition_name>
        <disposition_type>
          <disposition_type_id>3</disposition_type_id>
          <disposition_type_name>Approved</disposition_type_name>
        </disposition_type>
        <contact>John Doe</contact>
        <disposition_date>2012-01-04T10:34:40.897</disposition_date>
      </current_disposition>
      <campaign_type>
        <campaign_type_id>1</campaign_type_id>
        <campaign_type_name>Standard</campaign_type_name>
      </campaign_type>
      <note/>
    </conversion>
  </conversions>
</conversion_report_response> 
  

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired