REPORTS Conversions API Version 4 (DEPRECATED)

Ron Torres

Modified on: Tue, 15 Sep, 2015 at 1:28 PM

REPORTS Conversions API Version 4

Updated on 2014-04-04
Current Version: 13
Deprecated Version: 3
Requests Allowed: GET/SOAP

Summary:

Exports all conversion info filtered by campaign, affiliate offer, advertiser, or creative.

You can also obtain this from within your CAKE instance by going to the Reports main tab then the Conversions sub tab where you are allowed to export.

Resource/WSDL Page:

http://<your_domain_here>/api/4/reports.asmx?op=Conversions

Parameters

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

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

Must be a valid API key (existing and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

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

This start date will filter all conversions from a specific date.

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"

Example Values: 2014-02-15

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

This end date will filter all conversions from a specific date.

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"

Example Values: 2014-02-16

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

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

If passing anything <= 0 the result will include all affiliates.

Example Values: 1234

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

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

If passing anything <= 0 the result will include all advertisers.

Example Values: 1234

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

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

If passing anything <= 0 the result will include all offers.

Example Values: 1234

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

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

If passing anything <= 0 the result will include all campaigns.

Example Values: 1234

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

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

If passing anything <= 0 the result will include all creatives.

Example Values: 1234

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

Drives whether test conversions are returned.

Example Values: Y

start_at_row
Required
Type: INT
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: INT
Length (Max/Min): N/A

Must pass at some value, 100000 rows is the max allowed which means no limit.

Example Values: 3

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

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

Example Values: visitor_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

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET	http://demo.cakemarketing.com/api/4/reports.asmx/Conversions?api_key=dNJFmId9rI&start_date=7/30/13&end_date=7/31/13&affiliate_id=0&advertiser_id=0&offer_id=1000732&campaign_id=0&creative_id=0&include_tests=TRUE&start_at_row=0&row_limit=1&sort_field=conversion_date&sort_descending=FALSE

Sample XML Response:

<conversion_report_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/10/">
<success>true</success>
<row_count>1</row_count>
<conversions>
<conversion>
<conversion_id>357971</conversion_id>
<visitor_id>3976844</visitor_id>
<request_session_id>3460755</request_session_id>
<click_request_session_id xsi:nil="true"/>
<click_id xsi:nil="true"/>
<conversion_date>2013-07-30T16:39:06.4</conversion_date>
<last_updated>2013-09-30T18:00:00.427</last_updated>
<click_date xsi:nil="true"/>
<affiliate>
<affiliate_id xmlns="API:id_name_store">5360</affiliate_id>
<affiliate_name xmlns="API:id_name_store">CPA Ruskie</affiliate_name>
</affiliate>
<advertiser>
<advertiser_id xmlns="API:id_name_store">61</advertiser_id>
<advertiser_name xmlns="API:id_name_store">Money Minus Pets</advertiser_name>
</advertiser>
<offer>
<offer_id xmlns="API:id_name_store">1000732</offer_id>
<offer_name xmlns="API:id_name_store">Cake Fixed</offer_name>
</offer>
<offer_contract>
<offer_contract_id xmlns="API:id_name_store">1629</offer_contract_id>
<offer_contract_name xmlns="API:id_name_store"/>
</offer_contract>
<campaign_id>6330</campaign_id>
<creative>
<creative_id xmlns="API:id_name_store">1131617</creative_id>
<creative_name xmlns="API:id_name_store">1131617</creative_name>
</creative>
<sub_id_1/>
<sub_id_2/>
<sub_id_3/>
<sub_id_4/>
<sub_id_5/>
<conversion_type>Click - Fixed</conversion_type>
<paid>
<currency_id>1</currency_id>
<amount>16.6666</amount>
<formatted_amount>$16.67</formatted_amount>
</paid>
<received>
<currency_id>1</currency_id>
<amount>0.0000</amount>
<formatted_amount>$0.00</formatted_amount>
</received>
<step_reached>1</step_reached>
<pixel_dropped>false</pixel_dropped>
<suppressed>false</suppressed>
<returned>false</returned>
<test>false</test>
<transaction_id>test</transaction_id>
<conversion_ip_address>65.60.119.2</conversion_ip_address>
<conversion_referrer_url/>
<conversion_user_agent>Mozilla/5.0 (Windows NT 6.1) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.57 Safari/536.11</conversion_user_agent>
<campaign_type>
<campaign_type_id xmlns="API:id_name_store">1</campaign_type_id>
<campaign_type_name xmlns="API:id_name_store">Standard</campaign_type_name>
</campaign_type>
<note>Returns</note>
</conversion>
</conversions>
</conversion_report_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired.