TRACK MassConversionAdjustment API Version 2

Updated on 2014-04-11
Current Version: Version 2
Deprecated Version: V1
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/2/track.asmx?op=MassConversionAdjustment

 

Parameters

api_key
Required
Type: STRING
Length (Max): 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: BOOL

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

Mark as 'True' if you only want to return the number of conversions matching the filters. 'False' executes the changes.  Example Values: TRUE

start_date
Required
Type: DATE

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

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

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

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

Example Values: 1234

offer_id
Required
Type: INT

This is the identifier for a unique Offer. Obtained via EXPORT Offers API

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

Example Values: 1234

campaign_id
Required
Type: INT

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

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

Example Values: 0

sub_affiliate
Required
Type: STRING
Length (Max): 50

Enter in the Sub Affiliate name

Example Values:Empty

creative_id
Required
Type: INT

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

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

Example Values: 1234

affiliate_payment_type
Required
Type: ENUM

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

Example Values: paid_only

advertiser_payment_type
Required
Type: ENUM

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

Example Values: paid_only

total_to_adjust
Required
Type: INT

Total Conversions to Adjust

Example Values: 1

payout

Required
Type: DECIMAL

Price Paid Per Conversion

Example Values: 20

payout_currency_id
Required
Type: INT

Payout Currency ID. Obtained via GET Currencies API

Example Values: 1

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

Price Received Per Conversion

Example Values: 2

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

Received Currency ID

Example Values: 1

return_option
Required
Type: ENUM
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
Required
Type: STRING
Length (Max/Min): N/A

Free form Notes. Leave blank to skip

Example: banana

effective_date_option
Required
Type: ENUM
Length (Max/Min): N/A

The effective date these changes should be applied to. ["today", "conversion_date", "custom"]

Example Value: custom

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

 This date field is only used on effective_date_option = custom, otherwise this date is ignored.[MM/DD/YYYY HH:MM:SS]

Example Value: 12/12/2013 14:31:59

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

  


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.