StatsZipcodeDetail

Overview

Retrieve a count of contacts added within date ranges, with a total for ZIP/Postal code within the date range. Communication handled via an http form post.

Post Url

https://www.allclients.com/api/2/StatsZipcodeDetail.aspx
  • SSL is requred
  • White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.

Important Note

Submitting a blank field will result in clearing the data for that field out of the database. If you don’t want to change a field, do not submit it with the form.

Form Fields

Field Max Length* Required Notes
response_type No Default results will be returned in XML.Set this field value to json to return results in JSON format
accountid Yes Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
apikey Yes API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
startdate 10 Yes Add Date of the contact is on or after this date (Use US date format: mm/dd/yyyy)
enddate 10 Yes Add Date of the contact is before this date   (Use US date format:mm/dd/yyyy)Note: Using value 6/30/2012 will not include contacts added on 6/30.  Use 7/1/2013 to include contacts added BEFORE this date.

* An error will not result if Max Length is exceeded. Data will be trimmed to this length. 

Sample Results

Success Message

<?xml version="1.0"?>
<results>
  <stats>
    <count zipcode="90210">92</count>
    <count zipcode="95492">25</count>
    <count zipcode="99213">12</count>
  <stats>
</results> 

Sample Failure Message

<?xml version="1.0"?>
<results>
  <error>Authentication failed</error>
</results>