REPORTS Conversions API Version 11

Updated on 2014-04-04
Current Version: Version 13

Deprecated Version:  v4 v5 v6 v7 v8 v9 v10
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/11/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. Midnight is represented as 00:00:00.

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY","mm/dd/YYYY","mm/dd/YYYY HH:mm:ss"

Example Values: 2014-02-15, 12/2/2014 00:00:00

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

This end date will filter all conversions from a specific date. Midnight is represented as 00:00:00.

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY","mm/dd/YYYY","mm/dd/YYYY HH:mm:ss"

Example Values: 2014-02-16, 12/2/2014 01:00:00

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


The type of conversions to include in the response. ["all", "events", "conversions"]
event_id
Required
Type: INT

Filter to reduce report to only a specific event. Use EXPORT Offers API

Passing anything <= 0 the result will include all events.

Example Values: 26

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

This is the identifier for a unique Affiliate. Use EXPORT Affiliates API

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. Use EXPORT Advertisers API

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. Use EXPORT Offers API

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

Example Values: 1234

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


Affiliate Tag ID, used to filter the response by traffic from tagged Affiliates. Use GET AffiliateTags API

Passing anything <= 0 the result will include all affiliates.

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


Advertiser Tag ID, used to filter the response by traffic from tagged Advertiser. Use GET AdvertiserTags API

Passing anything <= 0 the result will include all affiliates.

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


Offer Tag ID, used to filter the response by traffic from tagged Offers. Use EXPORT Offers API

campaign_id

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

This is the identifier for a unique Campaign. Use EXPORT Campaigns API

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. Use EXPORT Creatives API

Passing anything <= 0 the result will include all creatives.

Example Values: 1234

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


Price Format ID, used to filter the response by specific price format. Use GET PriceFormats

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


Disposition Type, used to filter the response by disposition type passed. ["all", "pending", "rejected", "approved", "returned"]

disposition_id
Required
Type: SHORT
Length (Max/Min): N/A


This is the disposition identifier. Use TRACK ConversionDispositions API

Passing anything <= 0 the result will include all dispositions.

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


Used to filter the response of the report, by actions billing status. ["all", "billed", "unbilled", "partial"]

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


Used to filter the response of the report, by actions billing status. ["all", "billed", "unbilled", "partial"]

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


Drives whether test conversions are returned.

Example Values: both, tests or non_tests

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

http://demo.cakemarketing.com/api/11/reports.asmx/Conversions?api_key=ej7Cjys7pnJzSiMzsgzyth1u3d7PdXn&start_date=2014-07-23&end_date=2014-07-24&conversion_type=all&event_id=0&affiliate_id=0&advertiser_id=0&offer_id=0&affiliate_tag_id=0&advertiser_tag_id=0&offer_tag_id=0&campaign_id=0&creative_id=0&price_format_id=0&disposition_type=all&disposition_id=0&affiliate_billing_status=all&advertiser_billing_status=all&test_filter=both&start_at_row=0&row_limit=10000&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.