Conversion FTD Export API Documentation (RESTful)


Updated on 02-22-2019
Requests Allowed: HTTPS POST



Summary:

CAKE's Conversion FTD Export API allows programmatic access to conversion data for clients that are using Tracking Parameters. This API will not have data for clients utilizing CAKE's Affiliate Management. Note Global Setting is required to be enabled so that data will be available via this API.


Endpoint:

https://<admin-host-name>/api/1/conversion_ftd_export


Request Construction:


-The API request comprises of parameters that can be combined to query the click data.

Everything in the API is case-sensitive and format specific.


-Headers should include the API key.


-This API will return raw data in JSON only.


-the content-type is not necessary as long as the body of the post is formatted as a JSON string or if the variables are  passed in the query string.


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

Report Start Date [YYYY-MM-DD] 

Currently, this is the only format excepted.


Example Values: 2018-10-10T23:18:13.202Z
end_date
Required
Type: DATE
Length (Max/Min): N/A
Report End Date [YYYY-MM-DD]



Example Values: 2018-10-11T23:18:13.202Z


Response Parameters:

conversion_v3_id
Type: STRING

Equivalent of the Unique ID for Conversions/Events found in the UI

Example: bhm7o8mr8vlapk26v232

request_date
Type: DATE

Date of click request 

Example: 2018-10-10T23:18:13.202Z

request_session_id
Type: STRING

Equivalent of the Request Session ID found in the UI

Example: bhm7ojmr8vlcpk26v7fg
tracking_id
TypeSTRING

Tracking ID

Example: bg3it073e5dcckru01sg

visitor_id
TypeSTRING

Visitor ID

Example: bg3it073e5dcckru01s0

last_click_id
Type: STRING
Last last Click ID that was attributable to the conversion that was stored
Example: bhou8h38ppms8e5e0b40
cost
Type: DECIMAL
Cost tied to transactions
Example: 2.50
revenue
Type: DECIMAL
Revenue tied to transactions
Example: 25.00
touch_id
Type: STRING
Click ID or impression ID dependent on the traffic type ID
Example: 16
touch_type_id



Type: INTEGER
Touch type ID:
touch_type_id = 1 is premium click
touch_type_id = 2 is lite-click
touch_type_id = 3 impression
Example: 1
pixel_dropped
Type: BOOL
Was the Pixel dropped?
Example: False
order_id
Type: INTEGER
Equivalent of the E-commerce Order ID found in the UI
Example: 2
order_total
Type: DECIMAL
Total value of E-Commerce order
Example: 5.2
order_currency
Type: INTEGER
Currency type used for transaction
Example: 6
publisher_id
Type: INTEGER
Unique identifier for a source
Example: 101
creative_id
Type: INTEGER
Creative ID found in the Offer Card
Example: 55
offer_contract_id
Type: INTEGER
Offer Contract ID found in the Offer Card
Example: 108
offer_id
Type: INTEGER
Offer ID of the Offer Card
Example: 159
campaign_id
Type: INTEGER
Campaign Card ID
Example: 205
test
Type: BOOL
Is this a test
Example: False
conversion_type_id















Type: INTEGER
Conversion type IDs:
1 CPA
2 CPC
3 CPM
4 Lead Converted, No Sale
5 CPA from Impression
6 Fixed CPA
7 Fixed CPA from Impression
11 Click
12 Impression
13 Lead
14 Third Party
15 Manual Insertion
16 Lite-Click
17 Voucher Code
18 Missing Conversion
19 None
conversion_event_type_id
Type: INTEGER
User specific event id
Example: 3 
price_format





Type: INTEGER
price_format_id internal IDs
1 CPA
2 CPC
3 CPM
4 Fixed
5 RevShare
Example: 5
user_id

Type: STRING
User ID given by Advertiser, also found in the postback URL and/or browser pixel requests under the u= parameter
Example: hello@hiworld.com
transaction_id

Type: STRING
Transaction ID given by Advertiser, also found in the postback URL and/or browser pixel request under the t= parameter
Example: a2d5e2d


Sample JSON Response:

{  
    "conversions": [
        {
            "coversion_v3_id": "bg3iu3df0001o32u5h40",
            "request_date": "2018-12-04T20:51:09",
            "session_log_v3_id": "bg3it073e5dcckru01rg",
            "source_log_v3_id": "bg3it073e5dcckru01sg",
            "tracking_log_v3_id": "bg3it073e5dcckru01s0",
            "cost": 0,
            "revenue": 0,
            "touch_id": "106730",
            "touch_type_id": 1,
            "pixel_dropped": false,
            "order_id": null,
            "order_total": null,
            "order_currency_id": null,
            "publisher_id": 101,
            "creative_id": 4,
            "contract_id": 6,
            "campaign_id": 2,
            "campaign_contract_id": 2,
            "device_id": null,
            "test": false,
            "conversion_type_id": 11,
            "conversion_event_type_id": 5,
            "price_format_id": 1
        }  
    ]
}