TRACK MassConversionAdjustment API Version 1
Updated on 2014-04-11
Current Version: Version 2
Deprecated Version: NA
Requests Allowed: GET/SOAP


Summary:

This API is designed to make adjustments to conversions that have already happened. This API will not create or delete conversions.


Resource/WSDL Page:

http://<your_domain_here>/api/1/track.asmx?op=MassConversionAdjustment


Parameters

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

This api_key must be a valid API key (exisiting and NOT expired). You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.  

Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

get_current_totals_only
Required
Type: BOLL
Length (Max/Min): N/A

how Totals or Run Adjustment Query? ["TRUE" = Show Totals/DO NOT RUN QUERY, "FALSE" = Run Adjustment Query]

Example Values: TRUE

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

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

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

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

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

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

Example Values: 0

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

Enter in the Sub Affiliate name

Example Values:Empty

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

This is the identifier for a unique Creative. Use EXPORT Creatives API.

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

Example Values: 1234

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

conversion Affiliate Payment Type ["paid_only", "unpaid_only", "paid_and_unpaid"]

Example Values: paid_only

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

conversion Affiliate Payment Type ["paid_only", "unpaid_only", "paid_and_unpaid"]

Example Values: paid_only

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

Total Conversions to Adjust

Example Values: 1

payout
Optional
Type: DECIMAL
Length (Max/Min): N/A

Price Paid Per Conversion

Example Values: 20

payout_currency_id
Required Value/Optional?
Type: INT
Length (Max/Min): N/A

Payout Currency ID. Use Get Currencies API.

Example Values: 1

received
Required Value/Optional?
Type: DECIMAL
Length (Max/Min): N/A

Price Received Per Conversion

Example Values: 2

received_currency_id
Required Value/Optional?
Type: INT
Length (Max/Min): N/A

Received Currency ID. Use GET Currencies API.

Example Values: 1

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

Mark the Conversions as Returned? ["mark_as_returned", "mark_as_unreturned", "do_not_change"]

Example Values: do_not_change

note
Optional
Type: STRING
Length (Max/Min): N/A

Free form Notes. 

Example: banana

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

The billing option should be applied to; [ignore_billing or next_generated_bill or latest_generated_bill]

Example Value: ignore_billing

 **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/1/track.asmx/MassConversionAdjustment?api_key=dNJFmId9rI&get_current_totals_only=false&start_date=02%2F01%2F2014+&end_date=02%2F21%2F2014+&affiliate_id=1&offer_id=1001278&campaign_id=0&sub_affiliate=%5BEmpty%5D&creative_id=1132936&affiliate_payment_type=paid_and_unpaid&advertiser_payment_type=paid_and_unpaid&total_to_adjust=1&payout=20&payout_currency_id=1&received=2&received_currency_id=1&return_option=do_not_change&note=Appended+notes&effective_date_option=conversion_date&custom_date=1%2F2%2F2006

 

Sample XML Response:

<mass_conversion_adjustment_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/"> true 1 Conversion(s) Adjusted <conversions_found>1 <conversions_adjusted>1 <total_payout_old>20.0000 <total_received_old>2.0000 <total_payout_new>20.0000 <total_received_new>2.0000 <max_cdh_date>2014-02-20T12:52:31.127

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired.

Affiliate Not Found

Affiliate ID provided does not exist or is invalid.

Campaign Not Found

Campaign ID provided does not exist or is invalid.

Creative Not Found

Creative ID provided does not exist or is invalid.

SubAffiliate Not Found

SubAffiliate ID provided does not exist or is invalid.

Invalid Transaction IDs

Transaction IDs provided do not exist, are invalid or the total number of IDs is grater than the total_to_insert.