TRACK MassConversionInsert API Version 3
Updated on 2019-01-10
Deprecated Version: V2
Requests Allowed: GET/SOAP
Summary:
This API will allow you to add conversions to your instance.
Resource/WSDL Page:
http://yourdomainhere.com/api/3/track.asmx?op=MassConversionInsert
Parameters
| api_key Required Type: STRING Length (Max/Min): 50 | Must be a valid API key (existing and NOT expired) Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
| conversion_date Required Type: DATE Length (Max/Min): N/A | Allowed formats: "YYYY-mm-dd","dd-mm-YYYY" Example Values: 2014-04-11 |
| affiliate_id Required Type: INT Length (Max/Min): N/A | Must be an existing Affiliate ID. Use Export Affiliates API. Example Values: 10343 |
| campaign_id Required Type: INT Length (Max/Min): N/A | Must be an existing Campaign ID. Use EXPORT Campaigns API. Example Values: 1134 |
| sub_affiliate Required Type: STRING Length (Max/Min): N/A | Enter in the Sub Affiliate name |
| creative_id Required Type: INT Length (Max/Min): N/A | Must be an existing Creative ID Example Values: 1234 |
| total_to_insert Required Type: INT Length (Max/Min): N/A | Total Conversions to Insert Example Values: 3 |
| payout Required Type: DECIMAL Length (Max/Min): N/A | Price Paid Per Conversion |
| received Required Value/Optional? Type: DECIMAL Length (Max/Min): N/A | Price Received Per Conversion Example Values: 2.5 |
| note Optional Type: STRING Length (Max/Min): N/A | Free form Notes. This can be anything you want it to be. Example: banana |
| transaction_ids Optional Type: STRING Length (Max/Min): N/A | Transaction IDs for the conversions. [Comma separated list supported.] |
| 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_insert_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>Conversions Inserted</message> </mass_conversion_insert_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 greater than the total_to_insert. |
| Invalid unpaid_disposition_id and payout combination | The combination of unpaid_disposition_id and payout is not valid |