REPORTS PingPosts API Version 1
Updated on 07-14-2017
Current Version: Version 1
Requests Allowed: GET/SOAP
Summary:
This API would be built to extract the data from the Buyer Reports > Pings & Posts column. This API allows users to gain insights into ping and post details so they can gain more detailed insights into the performance of their ping tree.
Resource/WSDL Page:
http://<your_domain_here>/api/1/reports.asmx?op=PingPosts
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 |
This start date will filter all conversions from a specific date. Midnight is represented as 00:00:00. Allowed formats: "YYYY-mm-dd","dd-mm-YYYY","mm/dd/YYYY","mm/dd/YYYY HH:mm:ss" Example Values: 2014-02-15, 12/2/2014 00:00:00 |
|
end_date Required Type: DATE Length (Max/Min): N/A |
This end date will filter all conversions from a specific date. Midnight is represented as 00:00:00. When time stamp is excluded 00:00:00 is assumed and data on end date will not be included. Note: Cannot go further than a day (1 day max) Example Values: 2014-02-16, 12/2/2014 01:00:00 |
|
buyer_manager_id Required Type: INT Length (Max/Min): N/A |
ID is found in the Contact Card of the manager. Alternatively, you can use the following API to extract the same data. https://getcake.freshdesk.com/solution/articles/5000667362-export-buyers-api-version-2 Example Values: 1234 |
|
buyer_id Required Type: INT Length (Max/Min): N/A |
ID found in Buyer Card. Alternatively, you can use the following API to extract the same data. https://getcake.freshdesk.com/solution/articles/5000667362-export-buyers-api-version-2 Example Values: 1234 |
|
buyer_contract_id Required Type: INT Length (Max/Min): N/A |
Unique Identifier of the buyer contract id which is found in the Buyer Contract Card Can pass 0 for all Example Values: 1234 |
|
vertical_category_id Required Type: UNSIGNEDBYTE Length (Max/Min): N/A |
Vertical category IDs can be found using this API: https://getcake.freshdesk.com/solution/articles/5000546156--account-getverticalcategories-v2-affiliate Note: Can pass 0 if Buyer Contract ID is passed Example Values: 1234 |
|
vertical_id Required Type: SHORT Length (Max/Min): N/A |
Vertical ID can be found on the Vertical Card Can pass 0 if Buyer ID is passed Example Values: 2 |
|
affiliate_id Required Type: INT Length (Max/Min): N/A |
Obtained via EXPORT Affiliates API or found on the Affiliate Card https://getcake.freshdesk.com/solution/articles/5000546174-export-affiliates-api-version-5 Pass 0 for all. Example Values: 1234 |
|
subaffiliate_id Required Type: STRING Length (Max/Min): N/A |
Can pass 'null' to return all Example Values: 1258 |
|
offer_id Required Type: INT Length (Max/Min): N/A |
Obtained via EXPORT Offers API or on the Offer Card, Pass 0 for all. https://getcake.freshdesk.com/solution/articles/5000655203-export-offers-api-version-6 Note: Required if passing SubAffiliate Example Values: 1234 |
|
media_type_id Required Type: UNSIGNEDBYTE Length (Max/Min): N/A |
Obtained via GET MediaTypes API https://getcake.freshdesk.com/solution/articles/5000546170-get-mediatypes-api-version-1 Note: Must pass Affiliate ID in order to pass. Null to skip. " to find empty SubAffiliate |
|
multisell Required Type: STRING Length (Max/Min): N/A |
Accepted Values: both or multisells_only or non_multisells Example Values: both |
|
delivery_method Required Type: STRING Length (Max/Min): N/A |
Accepted Values: all or none or post or ping or non_ping Example Values: ping |
|
upsell Required Type: STRING Length (Max/Min): N/A |
Accepted Values: upsells_and_non_upsells or upsells_only or non_upsells Example Values: non_upsells |
|
vintage Required Type: STRING Length (Max/Min): N/A |
Accepted Values: vintages_and_no_vintages or vintages_only or no_vintages Example Values: no_vintages |
|
accepted Required Type: STRING Length (Max/Min): N/A |
Accepted Values: accepted_and_rejected or accepted_only or rejected_only Example Values: rejected_only |
|
is_ping_accept_post_reject Required Type: STRING Length (Max/Min): N/A |
Accepted Values: both or ping_accepted_post_rejectedonly or non_ping_accepted_post_rejected Example Values: both |
|
test Required Type: STRING Length (Max/Min): N/A |
Accepted Values: tests_and_non_tests or tests_only or non_tests Example Values: non_tests |
|
start_at_row Required Type: INT Length (Max/Min): N/A |
Must pass at least 0 as value, which means start at the beginning of the data set. Example Values: 1 |
|
row_limit Required Type: INT Length (Max/Min): N/A |
Note: Max rows is 5,000 If you pass a value greater than this we will only return 5,000 Example Values: 4000 |
Example Request
<pingposts xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/"> <success>true</success> <row_count>2</row_count> <pingposts_responses> <pingpost> <lead_id>AC9EA9CF</lead_id> <post_date>03/08/2017 5:26:41 PM</post_date> <post_time_ms>453</post_time_ms> <price_received>0</price_received> <request> http://emuirhead.com/cake/buyer.php?mail_to=eric@getcake.com email= </request> <response> Success<br>price:1223.389:price<br>URL:http://google.com?myparam=11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111:URL<br>session:12345abcdefg:session<br> </response> <success>false</success> <type>Unknown Response</type> <is_ping>false</is_ping> <campaign> <campaign_id>6945</campaign_id> <campaign_type> <campaign_type_id>1</campaign_type_id> <campaign_type_name>Standard</campaign_type_name> </campaign_type> </campaign> <buyer> <buyer_id xmlns="API:id_name_store">130</buyer_id> <buyer_name xmlns="API:id_name_store">Eric's Buyer</buyer_name> </buyer> <buyer_contract> <buyer_contract_id xmlns="API:id_name_store">144</buyer_contract_id> <buyer_contract_name xmlns="API:id_name_store">New Contract</buyer_contract_name> </buyer_contract> </pingpost> <pingpost> <lead_id>064B36BB</lead_id> <post_date>03/08/2017 5:29:48 PM</post_date> <post_time_ms>703</post_time_ms> <price_received>0</price_received> <request> http://emuirhead.com/cake/buyer.php?mail_to=eric@getcake.com email= </request> <response> Success<br>price:1223.389:price<br>URL:http://google.com?myparam=11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111:URL<br>session:12345abcdefg:session<br> </response> <success>false</success> <type>Unknown Response</type> <is_ping>false</is_ping> <campaign> <campaign_id>6945</campaign_id> <campaign_type> <campaign_type_id>1</campaign_type_id> <campaign_type_name>Standard</campaign_type_name> </campaign_type> </campaign> <buyer> <buyer_id xmlns="API:id_name_store">130</buyer_id> <buyer_name xmlns="API:id_name_store">Eric's Buyer</buyer_name> </buyer> <buyer_contract> <buyer_contract_id xmlns="API:id_name_store">144</buyer_contract_id> <buyer_contract_name xmlns="API:id_name_store">New Contract</buyer_contract_name> </buyer_contract> </pingpost> </pingposts_responses> </pingposts>