REPORTS LeadsbyAffiliateExport API Version 1
Updated on 2014-06/19
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP
Summary:
Returns an array of leads, potentially filtered by affiliate.
Resource/WSDL Page:
http://yourdomainhere.com/api/1/reports.asmx?op=LeadsByAffiliateExport
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", "mm-dd-YYYY", "mm-dd-YYYY hh:mm:ss" 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", "mm-dd-YYYY", "mm-dd-YYYY hh:mm:ss" 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 |
|
affiliate_id Required Type: INT Length (Max/Min): NA |
If passing anything <= 0 the result will include all affiliates. Example Values: 123456 |
|
contact_id Required Type: BOOL Length (Max/Min): NA |
The Affiliate Manager contact ID. 0 will include all results. Example Values: 0, 1, 155 |
**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/1/reports.asmx/LeadsByAffiliateExport?api_key=dNJFmId9rI&start_date=01/01/2016+00:00:00&end_date=01/30/2016+01:00:00&affiliate_id=0&contact_id=0 |
Sample XML Response:
<ArrayOfLeadsByAffiliate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/1/">
<LeadsByAffiliate>
<publisher_id>1112090</publisher_id>
<publisher_name>Brittany Affiliate</publisher_name>
<campaign_id>55381135</campaign_id>
<campaign_name>Validation</campaign_name>
<advertiser_id>901153</advertiser_id>
<advertiser_name>Brittany Adv.</advertiser_name>
<contract_id>763135</contract_id>
<creative_id>1139964</creative_id>
<creative_name>1139964</creative_name>
<lead_id>718900</lead_id>
<unique_id>7C4CBFD9</unique_id>
<first_name>BRITT</first_name>
<last_name>TEST</last_name>
<email_address/>
<ip_address>64.60.178.91</ip_address>
<subpublisher_id>135979</subpublisher_id>
<subid_1/>
<user_agent>
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.106 Safari/537.36
</user_agent>
<lead_date>2016-01-04T12:24:03.927</lead_date>
<vertical_id>1234</vertical_id>
<vertical_name>TR Testing</vertical_name>
<vertical_data>0</vertical_data>
<test>0</test>
<sellable>0</sellable>
<approved>0</approved>
<rejected>1</rejected>
<thrownout>1</thrownout>
<paid>0</paid>
<pixel_dropped>0</pixel_dropped>
<throttled>0</throttled>
<price_owed>0.0000</price_owed>
<price_received>0.0000</price_received>
<lead_score>50</lead_score>
<returned>0</returned>
<reason_name>Thrown Out</reason_name>
<all_vertical_data>
<data xmlns="">
<other_injury>true</other_injury>
<filter_migration>false</filter_migration>
<perforation_of_tissues_or_organs>false</perforation_of_tissues_or_organs>
<tilted_filter>false</tilted_filter>
<filter_unable_to_be_removed>false</filter_unable_to_be_removed>
</data>
</all_vertical_data>
<vertical_fields>
{best_time1:},{New_Question:},{bank_account:},{Insurance:},{LT:},{BirthDate:},{programOfInterest:},{SelfAssessedCredit:},{FormType:},{LoanType:},{LoanToValue:},{Veteran:},{affid:},{carlee:},{leadstatus:},{loanstatus:},{sex:},{company_size:},{gender:}
</vertical_fields>
</LeadsByAffiliate>
</ArrayOfLeadsByAffiliate>
Example Error Messages:
|
Error Message |
Likely Cause |
| Invalid API Key |
API key does not exist or is expired |