EXPORT PixelLogRequests API Version 1


Updated on 2017-06-13
Current Version: Version 1

Requests Allowed: GET & SOAP

 

Summary:


The pixel log displays all the pixel attempts made by your advertisers for any of your offers, active or inactive, for the purposes of better understanding how your advertisers have implemented your pixel(s). This API will allow you to call these logs for your record and review. 

 

Resource/WSDL Page:

http://<your_domain_here>/api/1/export.asmx?op=PixelLogRequests

 

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

This api_key will provide you with the ability to export Pixel Log Requests for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.
Example Value: 
Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
advertiser_id
Required
Type: INTEGER
Length (Max/Min): N/A
This is the identifier for a unique Advertiser.  0 to skip, Must be valid ID if greater than 0
Example Value: 1234
offer_id
Required
Type: INTEGER
Length (Max/Min): 50

This is the identifier for a unique Offer. 0 to skip. Must be valid ID if greater than 0
Example Value: 5678
start_date
Required 
Type: DATETIME
Length (Max/Min): N/A
Can only go back 60 days maximum. Less data than requested may be returned if it has already been truncated due to size.
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: DATETIME
Length (Max/Min): N/A

Midnight is represented as 00:00:00.
When the time stamp is excluded 00:00:00 is assumed and data on end date will not be included.
Allowed formats: "YYYY-mm-dd","dd-mm-YYYY","mm/dd/YYYY","mm/dd/YYYY HH:mm:ss"
Example Values: 2014-02-16, 12/2/2014 01:00:00
converted_only
Required
Type: BOOL
Length (Max/Min): N/A

TRUE value returns only converted pixels disposition whereas FALSE will return all pixel attempts.
Example Values: TRUE
start_at_row
Required
Type: INTEGER
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

Must pass at some value, 100000 rows is the max allowed which means no limit.
Example Values: 3
sort_descending
Required
Type: BOOL
Length (Max/Min): N/A
Sorting is based on the request date only.
The following values can only be used for this parameter (TRUE or FALSE).
Example Values: TRUE


 

Example Request

GET
http://demo-new.cakemarketing.com/api/1/export.asmx/PixelLogRequests?api_key=7kkLImWsRr2kPLjBwrPEd2g07ks8daj&advertiser_id=1215&offer_id=0&start_date=06-01-2017 00:00:00&end_date=06-12-2017 11:59:59&converted_only=FALSE&start_at_row=0&row_limit=500&sort_descending=TRUE

 

 

Sample XML Response:

 

<?xml version="1.0" encoding="UTF-8"?>
<pixel_log_requests_export_response>
  <success>true</success>
  <row_count>2</row_count>
  <pixel_log_requests>
    <pixel_log_request>
      <request_date>2016-07-26T15:03:00.99</request_date>
      <tracking_id>123456<tracking_id>
      <brand_advertiser>
        <brand_advertiser_id>1</brand_advertiser_id>
        <brand_advertiser_name>Tim's Advertiser</brand_advertiser_name>
      </brand_advertiser>
      <site_offer>
        <site_offer_id>1</site_offer_id>
        <site_offer_name>Tim's Offer</site_offer_name>
      </site_offer>
      <conversion_event_info>
        <conversion_event_id>1</conversion_event_id>
        <conversion_event_name>Conversion/Install</conversion_event_name>
        <conversion_event_type>Macro</conversion_event_type> ***This needs to be Macro or Micro for C4A clients and Conversion or Event for C4N**
      </conversion_event_info>
      <ip_address>12.299.43.91</ip_address>
      <request_url>http://stagingtrk.cakemarketing.com/p.ashx?o=123&f=pb&r=1234568&t=abc124</request_url>
      <referrer_url>http://www.google.com/order/thank_you_page</referrer_url>
      <ignored>false</ignored>
      <whitelisted>false</whitelisted>
      <conversion_id>9876543</conversion_id>
      <disposition>
        <disposition_id>61</disposition_id>
        <disposition_name>Conversion Stored</disposition_name>
      <disposition>
      <paid_disposition>
        <paid_disposition_id>30</paid_disposition_id>
        <paid_disposition_name>No Pay Campaign</paid_disposition_name>
      </paid_disposition>
    </pixel_log_request>
    <pixel_log_request>
      <request_date>2016-07-26T15:02:54.63</request_date>
      <tracking_id/>
      <brand_advertiser/>
        <brand_advertiser_id/>1</brand_advertiser_id>
        <brand_advertiser_name>Tim's Advertiser</brand_advertiser_name>
      </brand_advertiser>
      <ip_address>12.199.34.91</ip_address>
      <request_url>http://stagingtrk.cakemarketing.com/p.ashx?a=1&f=pb&r=1234567&t=abc123</request_url>
      <referrer_url>http://www.google.com</referrer_url>
      <ignored>true</ignored>
      <whitelisted>false</whitelisted>
      <conversion_id/>
      <disposition>
        <disposition_id>46</disposition_id>
        <disposition_name>Offer Not Found</disposition_name>
      <disposition>
    </pixel_log_request>
    <pixel_log_request>
      <request_date>2016-07-28T15:02:66.90</request_date>
      <tracking_id/>
      <ip_address>12.199.34.91</ip_address>
      <request_url>http://stagingtrk.cakemarketing.com/p.ashx?t=abc123</request_url>
      <referrer_url>http://www.google.com</referrer_url>
      <ignored>true</ignored>
      <whitelisted>false</whitelisted>
      <conversion_id/>
      <disposition>
        <disposition_id>46</disposition_id>
        <disposition_name>Offer Not Found</disposition_name>
      <disposition>
    </pixel_log_request>
  </pixel_log_requests>
</pixel_log_requests_export_response>


 

  

Example Error Messages:

Error Message
Likely Cause
Invalid API Key
API Key does not exist or is expired