TRACK MassConversionAdjustment API Version 3
Updated on 2019-10-01
Current Version: Version 2
Deprecated Version: V2
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/3/track.asmx?op=MassConversionAdjustment
Parameters
api_key | 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 | 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 | 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 | 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 | 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 | 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 | 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 | Enter in the Sub Affiliate name Example Values:Empty |
creative_id | 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 | conversion Affiliate Payment Type ["paid_only", "unpaid_only", "paid_and_unpaid"] Example Values: paid_only |
advertiser_payment_type | conversion Affiliate Payment Type ["paid_only", "unpaid_only", "paid_and_unpaid"] Example Values: paid_only |
total_to_adjust | Total Conversions to Adjust Example Values: 1 |
payout Required | Price Paid Per Conversion Example Values: 20 |
payout_currency_id | Payout Currency ID. Obtained via GET Currencies API Example Values: 1 |
received | Price Received Per Conversion Example Values: 2 |
received_currency_id | Received Currency ID Example Values: 1 |
return_option | Mark the Conversions as Returned? ["mark_as_returned", "mark_as_unreturned", "do_not_change"] Example Values: do_not_change |
note | Free form Notes. Leave blank to skip Example: banana |
effective_date_option | The effective date these changes should be applied to. ["today", "conversion_date", "custom"] Example Value: custom |
custom_date | 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 |
| unpaid_disposition_id Required Type: UNASSIGNEDBYTE Length (Max/Min): N/A | Unpaid disposition IDs can be found using our GET UnpaidDispositions V1 API: https://support.getcake.com/a/solutions/articles/13000068558?portalId=5000031597 This value should equal 0 if payout= is greater than 0. If payout= is 0 then unpaid_disposition_id= should have the ID associated with the unpaid disposition ID |
**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
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/3/"> <success>true</success> <message> Conversion(s) Adjusted</message> <conversions_found>0</conversions_found> <conversions_adjusted>0</conversions_adjusted> <total_payout_old>0.0000</total_payout_old> <total_received_old>0.0000</total_received_old> <total_payout_new>0.0000</total_payout_new> <total_received_new>0.0000</total_received_new> <max_cdh_date>0001-01-01T00:00:00</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. |
| Invalid unpaid_disposition_id and payout combination | The combination of unpaid_disposition_id and payout is not valid |