Submit a Ticket My Tickets
Welcome
Login  Sign up

REPORTS LeadsByBuyerExport API Version 4

REPORTS LeadsbyBuyerExport API Version 4

Updated on 2014-04-01
Current Version: Version 4
Deprecated Version: NA
Requests Allowed: GET&SOAP


Summary:

Returns an array of leads sorted by buyer properties

 

Resource/WSDL Page:

http://yourdomainhere/api/4/reports.asmx?op=LeadsByBuyer

 

Parameters

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

Must be a valid API key (existing and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

start_date
Required
Type: DATE
Length (Max/Min): NA

Allowed formats: "YYYY-mm-dd", "dd-mm-YYYY"

Example Values: 2014-04-24, 24-04-2014

end_date
Required
Type: DATE
Length (Max/Min): NA

Allowed formats: "YYYY-mm-dd", "dd-mm-YYYY"

When time stamp is excluded 00:00:00 is assumed, and data on end date will not be included.

Example Values: 2014-04-24, 24-04-2014

vertical_id
Required
Type: INT
Length (Max/Min): NA

If passing anything <= 0 the result will include all verticals.

Example Values: 123456

buyer_id
Required
Type: INT
Length (Max/Min): NA

If passing anything <= 0 the result will include all buyers.

Example Values: 123456

buyer_contract_id
Required
Type: INT
Length (Max/Min): NA

If passing anything <= 0 the result will include all buyer contracts.

Example Values: 123456

status_id
Required
Type: BYTE
Length (Max/Min): 0-255

If passing anything <= 0 the result will include all statuses.

Example Values: 123

substatus_id
Required
Type: BYTE
Length (Max/Min): 0-255

If passing anything <= 0 the result will include all substatuses.

Example Values: 123

start_at_row
Required
Type: INT
Length (Max/Min): NA

Starting Row Number [Usually "1", unless doing incremental API Calls]

Example Values: 1

row_limit
Required
Type: INT
Length (Max/Min): NA

Maximum Rows Returned ["0" = ALL Rows, "50000" = Maximum]

Example Values: 1

sort_field
Required
Type: STRING
Length (Max/Min): NA

Accepts "buyer_id", "buyer_name", "buyer_contract_id", "buyer_contract_name", "unique_id", "transaction_date", "ip_address", "first_name", "last_name", "email_address", "country", "state" or "price"

Example Values: price

sort_descending
Required
Type: BOOL
Length (Max/Min): NA

Sort Descending? ["TRUE", "FALSE"]

Example Values: True

 **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

GET

http://demo.cakemarketing.com/api/4/reports.asmx/LeadsByBuyer?api_key=dNJFmId9rI&start_date=01/01/2012+00:00:00&end_date=01/02/2012+23:00:00&
vertical_id=0&buyer_id=485&buyer_contract_id=315&status_id=0&sub_status_id=0&
start_at_row=1&row_limit=5&sort_field=transaction_date&sort_descending=FALSE

 


Sample XML Response:

<leads_by_buyer_report_response>
  <success>true</success>
  <row_count>5</row_count>
  <leads_by_buyer>
    <lead_by_buyer>
      <transaction_id>19137</transaction_id>
      <transaction_date>2012-01-01T05:02:32.77</transaction_date>
      <lead_id>856EB1C5</lead_id>
      <buyer>
        <buyer_id>485</buyer_id>
        <buyer_name>Buyer 485</buyer_name>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>315</buyer_contract_id>
        <buyer_contract_name>Buyer Contract 315</buyer_contract_name>
      </buyer_contract>
      <price>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <amount>18.0000</amount>
      </price>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <email_address>test@cakemarketing.com</email_address>
      <opted_in>false</opted_in>
      <phone_work>555-1212</phone_work>
      <city>Los Angeles</city>
      <state>CA</state>
      <zip_code>90120</zip_code>
      <best_time/>
      <all_vertical_data>
        <data>
          <debt_amount>15000</debt_amount>
        </data>
      </all_vertical_data>
      <affiliate>
        <affiliate_id>68</affiliate_id>
        <affiliate_name>Johnson and Co</affiliate_name>
      </affiliate>
      <sub_affiliate>
        <sub_affiliate_id>4364</sub_affiliate_id>
        <sub_affiliate_name>545138</sub_affiliate_name>
      </sub_affiliate>
      <buyer_lead_id/>
    </lead_by_buyer>
    <lead_by_buyer>
      <transaction_id>19138</transaction_id>
      <transaction_date>2012-01-01T05:09:13.853</transaction_date>
      <lead_id>6B98DEE7</lead_id>
      <buyer>
        <buyer_id>485</buyer_id>
        <buyer_name>Buyer 485</buyer_name>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>315</buyer_contract_id>
        <buyer_contract_name>Buyer Contract 315</buyer_contract_name>
      </buyer_contract>
      <price>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <amount>18.0000</amount>
      </price>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <email_address>test@cakemarketing.com</email_address>
      <opted_in>false</opted_in>
      <phone_work>555-1212</phone_work>
      <city>Los Angeles</city>
      <state>CA</state>
      <zip_code>90120</zip_code>
      <best_time/>
      <all_vertical_data>
        <data>
          <debt_amount>15000</debt_amount>
        </data>
      </all_vertical_data>
      <affiliate>
        <affiliate_id>48</affiliate_id>
        <affiliate_name>CPAButt</affiliate_name>
      </affiliate>
      <sub_affiliate>
        <sub_affiliate_id>4106</sub_affiliate_id>
        <sub_affiliate_name>MDTA1d2y</sub_affiliate_name>
      </sub_affiliate>
      <buyer_lead_id/>
    </lead_by_buyer>
    <lead_by_buyer>
      <transaction_id>19139</transaction_id>
      <transaction_date>2012-01-01T05:15:55.89</transaction_date>
      <lead_id>42F41894</lead_id>
      <buyer>
        <buyer_id>485</buyer_id>
        <buyer_name>Buyer 485</buyer_name>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>315</buyer_contract_id>
        <buyer_contract_name>Buyer Contract 315</buyer_contract_name>
      </buyer_contract>
      <price>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <amount>18.0000</amount>
      </price>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <email_address>test@cakemarketing.com</email_address>
      <opted_in>false</opted_in>
      <phone_work>555-1212</phone_work>
      <city>Los Angeles</city>
      <state>CA</state>
      <zip_code>90120</zip_code>
      <best_time/>
      <all_vertical_data>
        <data>
          <debt_amount>62500</debt_amount>
        </data>
      </all_vertical_data>
      <affiliate>
        <affiliate_id>48</affiliate_id>
        <affiliate_name>CPAButt</affiliate_name>
      </affiliate>
      <sub_affiliate>
        <sub_affiliate_id>8926</sub_affiliate_id>
        <sub_affiliate_name>ITC4D7</sub_affiliate_name>
      </sub_affiliate>
      <buyer_lead_id/>
    </lead_by_buyer>
    <lead_by_buyer>
      <transaction_id>19140</transaction_id>
      <transaction_date>2012-01-01T05:22:37.99</transaction_date>
      <lead_id>582EF453</lead_id>
      <buyer>
        <buyer_id>485</buyer_id>
        <buyer_name>Buyer 485</buyer_name>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>315</buyer_contract_id>
        <buyer_contract_name>Buyer Contract 315</buyer_contract_name>
      </buyer_contract>
      <price>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <amount>18.0000</amount>
      </price>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <email_address>test@cakemarketing.com</email_address>
      <opted_in>false</opted_in>
      <phone_work>555-1212</phone_work>
      <city>Los Angeles</city>
      <state>CA</state>
      <zip_code>90120</zip_code>
      <best_time/>
      <all_vertical_data>
        <data>
          <debt_amount>62500</debt_amount>
        </data>
      </all_vertical_data>
      <affiliate>
        <affiliate_id>5</affiliate_id>
        <affiliate_name>Academy Aff's</affiliate_name>
      </affiliate>
      <sub_affiliate>
        <sub_affiliate_id>2794</sub_affiliate_id>
        <sub_affiliate_name>4930</sub_affiliate_name>
      </sub_affiliate>
      <buyer_lead_id/>
    </lead_by_buyer>
    <lead_by_buyer>
      <transaction_id>19141</transaction_id>
      <transaction_date>2012-01-01T05:29:19.643</transaction_date>
      <lead_id>0A29C4B8</lead_id>
      <buyer>
        <buyer_id>485</buyer_id>
        <buyer_name>Buyer 485</buyer_name>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>315</buyer_contract_id>
        <buyer_contract_name>Buyer Contract 315</buyer_contract_name>
      </buyer_contract>
      <price>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <amount>18.0000</amount>
      </price>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <email_address>test@cakemarketing.com</email_address>
      <opted_in>false</opted_in>
      <phone_work>555-1212</phone_work>
      <city>Los Angeles</city>
      <state>CA</state>
      <zip_code>90120</zip_code>
      <best_time/>
      <all_vertical_data>
        <data>
          <debt_amount>27500</debt_amount>
        </data>
      </all_vertical_data>
      <affiliate>
        <affiliate_id>5</affiliate_id>
        <affiliate_name>Academy Aff's</affiliate_name>
      </affiliate>
      <sub_affiliate>
        <sub_affiliate_id>2794</sub_affiliate_id>
        <sub_affiliate_name>4930</sub_affiliate_name>
      </sub_affiliate>
      <buyer_lead_id/>
    </lead_by_buyer>
  </leads_by_buyer>
</leads_by_buyer_report_response>



Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.