API: 
Consumer Intent API
API Class: 
Consumer Intent API
Description: 

This method retrieves vehicle lead metrics data in a given set of Zip Codes.

URL

Note: Ensure all testing is done in development environment prior to moving to production.

Environment URL
development https://api-st.cars.com/ConsumerIntent/1.0/rest/reports/leadCount
production https://api.cars.com/ConsumerIntent/1.0/rest/reports/leadCount

 

Request

Request Example

https://api.cars.com/ConsumerIntent/1.0/rest/reports/leadCount? make=Ford&model=F150&vehicleYear=2005&zipCode=77338&startDate=05/15/2016 &endDate=06/10/2016&apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request Parameters
Request Parameter Type Example value Description Required
make String Ford Vehicle Make yes
model String F150 Vehicle Model yes
vehicleYear Integer 2005 Vehicle Year yes
zipCode String 12345,99999 Comma delimited list of Zip Codes. Up to 10 zip codes can be entered yes
startDate Date 05/15/2016 Start Date of date range. Must be within 60 days of yesterday's date. yes
endDate Date 07/15/2016 End Date of data range. Must be after Start Date. yes
apikey String xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx API Key given by Cars.com yes

 

Response

Response Data Formats
Response type Header value
xml Accept: application/xml
json Accept: application/json
ConsumerActivityResults
Element Type Description
consumerActivity ConsumerActivity See ConsumerActivity element description below
ConsumerActivity
Element Type Description
summaryDate Date Summary Date
vehicleMake String Vehicle Make
vehicleModel String Vehicle Model
vehicleYear String Vehicle Year
zipCode String Zip Code
printVehicleContactCount Int Total print Vehicle Contact Count
mapDealerContactCount Int Total Map Dealer Contact Count
visitDealerWebContactCount Int Total Visit Dealer Web Contact Count
emailLeadsCount Int Total Email Leads Count
chatLeadsCount Int Total Chat Leads Count
Response XML example
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<consumerActivityResults>
    <consumerActivity>
        <summaryDate>2016-05-15 00:00:00</summaryDate>
        <vehicleMake>Ford</vehicleMake>
        <vehicleModel>F150</vehicleModel>
        <vehicleYear>2005</vehicleYear>
        <zipCode>77338</zipCode>
        <printVehicleContactCount>1</printVehicleContactCount>
        <mapDealerContactCount>4</mapDealerContactCount>
        <visitDealerWebContactCount>4</visitDealerWebContactCount>
        <emailLeadsCount>2</emailLeadsCount>
        <chatLeadsCount>2</chatLeadsCount>
    </consumerActivity>
    <consumerActivity>
        <summaryDate>2016-05-16 00:00:00</summaryDate>
        <vehicleMake>Ford</vehicleMake>
        <vehicleModel>F150</vehicleModel>
        <vehicleYear>2005</vehicleYear>
        <zipCode>77338</zipCode>
        <printVehicleContactCount>0</printVehicleContactCount>
        <mapDealerContactCount>4</mapDealerContactCount>
        <visitDealerWebContactCount>0</visitDealerWebContactCount>
        <emailLeadsCount>0</emailLeadsCount>
        <chatLeadsCount>0</chatLeadsCount>
    </consumerActivity>
    <consumerActivity>
        <summaryDate>2016-05-17 00:00:00</summaryDate>
        <vehicleMake>Ford</vehicleMake>
        <vehicleModel>F150</vehicleModel>
        <vehicleYear>2005</vehicleYear>
        <zipCode>77338</zipCode>
        <printVehicleContactCount>0</printVehicleContactCount>
        <mapDealerContactCount>0</mapDealerContactCount>
        <visitDealerWebContactCount>2</visitDealerWebContactCount>
        <emailLeadsCount>0</emailLeadsCount>
        <chatLeadsCount>0</chatLeadsCount>
    </consumerActivity>
    <consumerActivity>
        <summaryDate>2016-05-18 00:00:00</summaryDate>
        <vehicleMake>Ford</vehicleMake>
        <vehicleModel>F150</vehicleModel>
        <vehicleYear>2005</vehicleYear>
        <zipCode>77338</zipCode>
        <printVehicleContactCount>0</printVehicleContactCount>
        <mapDealerContactCount>0</mapDealerContactCount>
        <visitDealerWebContactCount>0</visitDealerWebContactCount>
        <emailLeadsCount>0</emailLeadsCount>
        <chatLeadsCount>0</chatLeadsCount>
    </consumerActivity>
    <consumerActivity>
        <summaryDate>2016-05-19 00:00:00</summaryDate>
        <vehicleMake>Ford</vehicleMake>
        <vehicleModel>F150</vehicleModel>
        <vehicleYear>2005</vehicleYear>
        <zipCode>77338</zipCode>
        <printVehicleContactCount>2</printVehicleContactCount>
        <mapDealerContactCount>5</mapDealerContactCount>
        <visitDealerWebContactCount>1</visitDealerWebContactCount>
        <emailLeadsCount>0</emailLeadsCount>
        <chatLeadsCount>2</chatLeadsCount>
    </consumerActivity>
    <consumerActivity>
        <summaryDate>2016-05-20 00:00:00</summaryDate>
        <vehicleMake>Ford</vehicleMake>
        <vehicleModel>F150</vehicleModel>
        <vehicleYear>2005</vehicleYear>
        <zipCode>77338</zipCode>
        <printVehicleContactCount>0</printVehicleContactCount>
        <mapDealerContactCount>0</mapDealerContactCount>
        <visitDealerWebContactCount>1</visitDealerWebContactCount>
        <emailLeadsCount>6</emailLeadsCount>
        <chatLeadsCount>3</chatLeadsCount>
    </consumerActivity>
</consumerActivityResults>


Response JSON example
{
  "ConsumerActivityResults": {
    "consumerActivity": [
      {
        "summaryDate": "2016-05-15 00:00:00",
        "vehicleMake": "Ford",
        "vehicleModel": "F150",
        "vehicleYear": "2005",
        "zipCode": "77338",
        "printVehicleContactCount": "0",
        "mapDealerContactCount": "0",
        "visitDealerWebContactCount": "0",
        "emailLeadsCount": "0",
        "chatLeadsCount": "0"
      },
      {
        "summaryDate": "2016-05-16 00:00:00",
        "vehicleMake": "Ford",
        "vehicleModel": "F150",
        "vehicleYear": "2005",
        "zipCode": "77338",
        "printVehicleContactCount": "0",
        "mapDealerContactCount": "0",
        "visitDealerWebContactCount": "0",
        "emailLeadsCount": "0",
        "chatLeadsCount": "0"
      },
      {
        "summaryDate": "2016-05-17 00:00:00",
        "vehicleMake": "Ford",
        "vehicleModel": "F150",
        "vehicleYear": "2005",
        "zipCode": "77338",
        "printVehicleContactCount": "0",
        "mapDealerContactCount": "0",
        "visitDealerWebContactCount": "0",
        "emailLeadsCount": "0",
        "chatLeadsCount": "0"
      },
      {
        "summaryDate": "2016-05-18 00:00:00",
        "vehicleMake": "Ford",
        "vehicleModel": "F150",
        "vehicleYear": "2005",
        "zipCode": "77338",
        "printVehicleContactCount": "0",
        "mapDealerContactCount": "0",
        "visitDealerWebContactCount": "0",
        "emailLeadsCount": "0",
        "chatLeadsCount": "0"
      },
      {
        "summaryDate": "2016-05-19 00:00:00",
        "vehicleMake": "Ford",
        "vehicleModel": "F150",
        "vehicleYear": "2005",
        "zipCode": "77338",
        "printVehicleContactCount": "0",
        "mapDealerContactCount": "0",
        "visitDealerWebContactCount": "0",
        "emailLeadsCount": "0",
        "chatLeadsCount": "0"
      },
      {
        "summaryDate": "2016-05-20 00:00:00",
        "vehicleMake": "Ford",
        "vehicleModel": "F150",
        "vehicleYear": "2005",
        "zipCode": "77338",
        "printVehicleContactCount": "0",
        "mapDealerContactCount": "0",
        "visitDealerWebContactCount": "0",
        "emailLeadsCount": "0",
        "chatLeadsCount": "0"
      }
    ]
  }
}

 

No Match Response

No Match Response Example
{
  "ConsumerActivityResults": {
    "message": " No Cars.com Make_Model_Year match. We have the following  Model - F150S available for Year - 2005 Make - Ford",
    "consumerActivity": [
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Crown Victoria",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "E150",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Escape Hybrid",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Escape",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "F150",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "F350",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Excursion",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Expedition",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Explorer",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Explorer Sport Trac",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "F250",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Focus",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Freestyle",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Five Hundred",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Freestar",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "GT",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Mustang",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Ranger",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Taurus",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "Thunderbird",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "E350",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "E250",
        "vehicleYear": "2005"
      },
      {
        "vehicleMake": "Ford",
        "vehicleModel": "E350 Super Duty",
        "vehicleYear": "2005"
      }
    ]
  }
}

 

No Data Response

No Data Response Example
{
  "ConsumerActivityResults": {
    "message": " No data found for Year - 2005  Make - Ford Model - F150 in ZipCode(s) - [00000]",
    "consumerActivity": []
  }
}
Test
Method Type: 
GET