Submit a Ticket My Tickets
Welcome
Login  Sign up
  1. CAKE
  2. Solution home
  3. Our API
  4. ARCHIVED - API Docs (Old Format)

[Reports] LeadsByBuyer (V4) - Admin

Ron Torres
Modified on: Fri, 18 Sep, 2015 at 4:36 PM

WSDL Page:  http://<your_domain_here>/api/4/reports.asmx?op=LeadsByBuyer

 

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

start_date / DATETIME = Report Start Date [MM/DD/YYYY HH:MM:SS]

end_date / DATETIME = Report End Date [MM/DD/YYYY HH:MM:SS]

vertical_id / INT (short) = Vertical ID ["0" = ALL Verticals] {See get.asmx > Verticals}

buyer_id / INT = Buyer ID ["0" = ALL Buyers] {See export.asmx > Buyers}

buyer_contract_id / INT = Buyer Contract ID ["0" = ALL Buyer Contracts] {See export.asmx > BuyerContracts}

status_id / INT (unsignedByte) = Lead Status ID ["0" = ALL Lead Statuses]

sub_status_id / INT (unsignedByte) = Lead Sub Status ID ["0" = ALL Lead Sub Statuses]

start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]

row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]

sort_field / STRING = Sort Field ["buyer_id", "buyer_name", "buyer_contract_id", "buyer_contract_name", "unique_id", "transaction_date", "ip_address", "first_name", "last_name", "email_address", "country", "state", "price"]

sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]

 

Parameter Types:

api_key - ID

start_date - ID

end_date - ID

vertical_id - ID

buyer_id - ID

buyer_contract_id - ID

status_id - ID

sub_status_id - ID

start_at_row - ID

row_limit - ID

sort_field - ID

sort_descending - ID

 

Sample GET Call:

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>[email protected]</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>[email protected]</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>[email protected]</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>[email protected]</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>[email protected]</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>

Did you find it helpful? Yes No

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

Related Articles