API: 
Dealer Metrics API
API Class: 
Dealer Metrics API
Description: 

This method retrieves vehicle information, analytics and performance reports for all vehicle listings on a given day or month for a Dealer.  Options to paginate the response are also included.

URL

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

Environment URL
development https://api.cars.com/DealerMetricsService/1.0/rest/reports/contactdetails/totalmetrics
production https://api.cars.com/DealerMetricsService/1.0/rest/reports/contactdetails/totalmetrics

Request

Request Data Formats

N/A

Request Parameters
Request Parameter Type Example value Description Required
customerId Integer 5785421 Customer ID yes
day Integer 1-31 Day - If not passed, request returns month report no
month Integer 1-12 Month yes
year Integer 2014 Year yes
start Integer 1 Requested page of results yes
pageSize Integer 100 Requested number of results per page yes
apikey String xo0HjxkG1087GPUtt0TAxTzrkwhYzAKJ API Key given by Cars.com yes

 

 

 

 

Response

Response Data Formats
Response type Header value
xml Accept: application/xml
json Accept: application/json
Response Elements
TotalMetricsResult
Element Type Description
start Int Starting page of results
pageSize Int Number of results per page
totalNumberOfVehicleIds Int Full number of results that you can paginate through
VehicleDetailsResult VehicleDetailsResult See VehicleDetailsResult element description below
VehicleDetailsResult
Element Type Description
vehicleInfo VehicleInfo See VehicleInfo element description below
leadDetails LeadDetails See LeadDetails element description below
contactSummary ContactSummary See ContactSummary element description below
VehicleInfo
Element Type Description
classifiedAdId String Classified Ad ID
stockNumber String Stock Number
vehicleYear String Vehicle Year
vehicleMake String Vehicle Make
vehicleModel String Vehicle Model
vin String Vin Number
stockType String Stock Type Code
vehicleStatus String Vehicle Status
listingPrice String Listing Price
numberOfPhotos BigInteger Total number of photos
sellerNotes String Seller Notes
currentAge BigInteger Current Age
deletedAge BigInteger Deleted Age
deletedLastLeadType String Deleted Last Lead Type
deletedLastLeadDateTime String Deleted Last Lead Date and Time
LeadDetails
Element Type Description
adPrintDetails AdPrintDetails See AdPrintDetails element description below
mapViewDetails MapViewDetails See MapViewDetails element description below
clickThruDetails ClickThruDetails See ClickThruDetails element description below
emailDetails EmailDetails See EmailDetails element description below
chatDetails ChatDetails See ChatDetails element description below
AdPrintDetails
Element Type Description
dateTime Object Date and time of activity
MapViewDetails
Element Type Description
dateTime Object Date and time of activity
ClickThruDetails
Element Type Description
dateTime Object Date and time of activity
EmailDetails
Element Type Description
dateTime Object Date and time of activity
customerName String Customer Email Address
ChatDetails
Element Type Description
dateTime Object Date and time of activity
handledBy String Name of person who handled the Chat session
chatMessageLength Integer Length of chat
ContactSummary
Element Type Description
searchViews Object Total number of search views
detailViews Object Total number of detail views
conversionRate Object Ratio of search views to detail views
totalContacts Object Sum of all lead details
Response XML example
<totalMetricsResult>
   <start>1</start>
   <pageSize>7</pageSize>
   <totalNumberofVehicleIds>387</totalNumberofVehicleIds>
   <vehicleDetailsResult>
      <vehicleInfo>
         <classifiedAdId>653288533</classifiedAdId>
         <stockNumber>FUX96963</stockNumber>
         <vehicleYear>2011</vehicleYear>
         <vehicleMake>MINI</vehicleMake>
         <vehicleModel>Cooper</vehicleModel>
         <vin>WMWSU3C59BTX96963</vin>
         <vehicleStatus>Deleted</vehicleStatus>
         <deletedAge>113</deletedAge>
      </vehicleInfo>
      <leadDetails>
         <clickThruDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/14/2016 05:46 AM CST</dateTime>
         </clickThruDetails>
         <clickThruDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/14/2016 05:47 AM CST</dateTime>
         </clickThruDetails>
         <emailDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/05/2016 05:57 AM CST</dateTime>
            <customerName xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">clrseitz@qis.net</customerName>
         </emailDetails>
      </leadDetails>
      <contactSummary>
         <searchViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1407</searchViews>
         <detailViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">16</detailViews>
         <conversionRate xsi:type="xs:double" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1.14</conversionRate>
         <totalContacts xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">3</totalContacts>
      </contactSummary>
   </vehicleDetailsResult>
   <vehicleDetailsResult>
      <vehicleInfo>
         <classifiedAdId>657220681</classifiedAdId>
         <stockNumber>F6271944</stockNumber>
         <vehicleYear>2016</vehicleYear>
         <vehicleMake>Mazda</vehicleMake>
         <vehicleModel>Mazda3</vehicleModel>
         <vin>3MZBM1W70GM271944</vin>
         <stockType>N</stockType>
         <vehicleStatus>Current</vehicleStatus>
         <listingPrice>21004</listingPrice>
         <numberOfPhotos>20</numberOfPhotos>
         <currentAge>131</currentAge>
      </vehicleInfo>
      <contactSummary>
         <searchViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">86</searchViews>
         <detailViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1</detailViews>
         <conversionRate xsi:type="xs:double" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1.16</conversionRate>
         <totalContacts xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">0</totalContacts>
      </contactSummary>
   </vehicleDetailsResult>
   <vehicleDetailsResult>
      <vehicleInfo>
         <classifiedAdId>650522583</classifiedAdId>
         <stockNumber>FP189656</stockNumber>
         <vehicleYear>2013</vehicleYear>
         <vehicleMake>Jeep</vehicleMake>
         <vehicleModel>Patriot</vehicleModel>
         <vin>1C4NJRBB0DD189656</vin>
         <vehicleStatus>Deleted</vehicleStatus>
         <deletedAge>108</deletedAge>
      </vehicleInfo>
      <leadDetails>
         <mapViewDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/29/2016 11:40 AM CST</dateTime>
         </mapViewDetails>
         <emailDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/12/2016 09:43 PM CST</dateTime>
            <customerName xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">paigeduvall101@gmail.com</customerName>
         </emailDetails>
         <emailDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/12/2016 09:42 PM CST</dateTime>
            <customerName xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">paigeduvall101@gmail.com</customerName>
         </emailDetails>
         <emailDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/11/2016 02:01 PM CST</dateTime>
            <customerName xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">alixvanderwiele@aol.com</customerName>
         </emailDetails>
      </leadDetails>
      <contactSummary>
         <searchViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">2427</searchViews>
         <detailViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">77</detailViews>
         <conversionRate xsi:type="xs:double" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">3.17</conversionRate>
         <totalContacts xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">4</totalContacts>
      </contactSummary>
   </vehicleDetailsResult>
   <vehicleDetailsResult>
      <vehicleInfo>
         <classifiedAdId>656285131</classifiedAdId>
         <stockNumber>FUC59564</stockNumber>
         <vehicleYear>2013</vehicleYear>
         <vehicleMake>Ford</vehicleMake>
         <vehicleModel>Escape</vehicleModel>
         <vin>1FMCU9J95DUC59564</vin>
         <vehicleStatus>Deleted</vehicleStatus>
         <deletedAge>1</deletedAge>
      </vehicleInfo>
      <leadDetails>
         <mapViewDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/22/2016 03:20 PM CST</dateTime>
         </mapViewDetails>
         <mapViewDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/22/2016 11:50 AM CST</dateTime>
         </mapViewDetails>
         <mapViewDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/22/2016 00:58 AM CST</dateTime>
         </mapViewDetails>
         <mapViewDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/22/2016 00:57 AM CST</dateTime>
         </mapViewDetails>
      </leadDetails>
      <contactSummary>
         <searchViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1102</searchViews>
         <detailViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">29</detailViews>
         <conversionRate xsi:type="xs:double" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">2.63</conversionRate>
         <totalContacts xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">4</totalContacts>
      </contactSummary>
   </vehicleDetailsResult>
   <vehicleDetailsResult>
      <vehicleInfo>
         <classifiedAdId>655531698</classifiedAdId>
         <stockNumber>FP832781</stockNumber>
         <vehicleYear>2008</vehicleYear>
         <vehicleMake>Subaru</vehicleMake>
         <vehicleModel>Impreza</vehicleModel>
         <vin>JF1GH63688H832781</vin>
         <stockType>Used</stockType>
         <vehicleStatus>Deleted</vehicleStatus>
         <deletedAge>28</deletedAge>
      </vehicleInfo>
      <leadDetails>
         <clickThruDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/05/2016 06:30 PM CST</dateTime>
         </clickThruDetails>
         <chatDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/05/2016 06:30 PM CST</dateTime>
            <handledBy xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">Justin  Ledbetter</handledBy>
            <chatMessageLength xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">3</chatMessageLength>
         </chatDetails>
      </leadDetails>
      <contactSummary>
         <searchViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1347</searchViews>
         <detailViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">25</detailViews>
         <conversionRate xsi:type="xs:double" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1.86</conversionRate>
         <totalContacts xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">2</totalContacts>
      </contactSummary>
   </vehicleDetailsResult>
   <vehicleDetailsResult>
      <vehicleInfo>
         <classifiedAdId>653645083</classifiedAdId>
         <stockNumber>FU025479</stockNumber>
         <vehicleYear>2011</vehicleYear>
         <vehicleMake>Nissan</vehicleMake>
         <vehicleModel>Juke</vehicleModel>
         <vin>JN8AF5MV8BT025479</vin>
         <vehicleStatus>Deleted</vehicleStatus>
         <deletedAge>87</deletedAge>
      </vehicleInfo>
      <leadDetails>
         <adPrintDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/10/2016 04:38 PM CST</dateTime>
         </adPrintDetails>
         <mapViewDetails>
            <dateTime xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">01/29/2016 05:39 PM CST</dateTime>
         </mapViewDetails>
      </leadDetails>
      <contactSummary>
         <searchViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1924</searchViews>
         <detailViews xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">26</detailViews>
         <conversionRate xsi:type="xs:double" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">1.35</conversionRate>
         <totalContacts xsi:type="xs:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">3</totalContacts>
      </contactSummary>
   </vehicleDetailsResult>
   <vehicleDetailsResult>
      <classifiedAdId>655007604</classifiedAdId>
      <message>Listing details not found.</message>
   </vehicleDetailsResult>
</totalMetricsResult>
Response JSON example
{"TotalMetricsResult": {
   "start": 1,
   "pageSize": 7,
   "totalNumberofVehicleIds": 387,
   "vehicleDetailsResult":    [
   {
         "vehicleInfo":          {
            "classifiedAdId": "653288533",
            "stockNumber": "FUX96963",
            "vehicleYear": "2011",
            "vehicleMake": "MINI",
            "vehicleModel": "Cooper",
            "vin": "WMWSU3C59BTX96963",
            "vehicleStatus": "Deleted",
            "deletedAge": 113
         },
         "leadDetails":          {
            "adPrintDetails": [],
            "mapViewDetails": [],
            "clickThruDetails":             [
               {"dateTime": "01/14/2016 05:46 AM CST"},
               {"dateTime": "01/14/2016 05:47 AM CST"}
            ],
            "emailDetails": [            {
               "dateTime": "01/05/2016 05:57 AM CST",
               "customerName": "clrseitz@qis.net"
            }],
            "chatDetails": []
         },
         "contactSummary":          {
            "searchViews": 1407,
            "detailViews": 16,
            "conversionRate": 1.14,
            "totalContacts": 3
         }
      },
      {
         "vehicleInfo":          {
            "classifiedAdId": "657220681",
            "stockNumber": "F6271944",
            "vehicleYear": "2016",
            "vehicleMake": "Mazda",
            "vehicleModel": "Mazda3",
            "vin": "3MZBM1W70GM271944",
            "stockType": "N",
            "vehicleStatus": "Current",
            "listingPrice": "21004",
            "numberOfPhotos": 20,
            "currentAge": 131
         },
         "contactSummary":          {
            "searchViews": 86,
            "detailViews": 1,
            "conversionRate": 1.16,
            "totalContacts": 0
         }
      },
      {
         "vehicleInfo":          {
            "classifiedAdId": "650522583",
            "stockNumber": "FP189656",
            "vehicleYear": "2013",
            "vehicleMake": "Jeep",
            "vehicleModel": "Patriot",
            "vin": "1C4NJRBB0DD189656",
            "vehicleStatus": "Deleted",
            "deletedAge": 108
         },
         "leadDetails":          {
            "adPrintDetails": [],
            "mapViewDetails": [{"dateTime": "01/29/2016 11:40 AM CST"}],
            "clickThruDetails": [],
            "emailDetails":             [
                              {
                  "dateTime": "01/12/2016 09:43 PM CST",
                  "customerName": "paigeduvall101@gmail.com"
               },
                              {
                  "dateTime": "01/12/2016 09:42 PM CST",
                  "customerName": "paigeduvall101@gmail.com"
               },
                              {
                  "dateTime": "01/11/2016 02:01 PM CST",
                  "customerName": "alixvanderwiele@aol.com"
               }
            ],
            "chatDetails": []
         },
         "contactSummary":          {
            "searchViews": 2427,
            "detailViews": 77,
            "conversionRate": 3.17,
            "totalContacts": 4
         }
      },
      {
         "vehicleInfo":          {
            "classifiedAdId": "656285131",
            "stockNumber": "FUC59564",
            "vehicleYear": "2013",
            "vehicleMake": "Ford",
            "vehicleModel": "Escape",
            "vin": "1FMCU9J95DUC59564",
            "vehicleStatus": "Deleted",
            "deletedAge": 1
         },
         "leadDetails":          {
            "adPrintDetails": [],
            "mapViewDetails":             [
               {"dateTime": "01/22/2016 03:20 PM CST"},
               {"dateTime": "01/22/2016 11:50 AM CST"},
               {"dateTime": "01/22/2016 00:58 AM CST"},
               {"dateTime": "01/22/2016 00:57 AM CST"}
            ],
            "clickThruDetails": [],
            "emailDetails": [],
            "chatDetails": []
         },
         "contactSummary":          {
            "searchViews": 1102,
            "detailViews": 29,
            "conversionRate": 2.63,
            "totalContacts": 4
         }
      },
      {
         "vehicleInfo":          {
            "classifiedAdId": "655531698",
            "stockNumber": "FP832781",
            "vehicleYear": "2008",
            "vehicleMake": "Subaru",
            "vehicleModel": "Impreza",
            "vin": "JF1GH63688H832781",
            "stockType": "Used",
            "vehicleStatus": "Deleted",
            "deletedAge": 28
         },
         "leadDetails":          {
            "adPrintDetails": [],
            "mapViewDetails": [],
            "clickThruDetails": [{"dateTime": "01/05/2016 06:30 PM CST"}],
            "emailDetails": [],
            "chatDetails": [            {
               "dateTime": "01/05/2016 06:30 PM CST",
               "handledBy": "Justin  Ledbetter",
               "chatMessageLength": "3"
            }]
         },
         "contactSummary":          {
            "searchViews": 1347,
            "detailViews": 25,
            "conversionRate": 1.86,
            "totalContacts": 2
         }
      },
      {
         "vehicleInfo":          {
            "classifiedAdId": "653645083",
            "stockNumber": "FU025479",
            "vehicleYear": "2011",
            "vehicleMake": "Nissan",
            "vehicleModel": "Juke",
            "vin": "JN8AF5MV8BT025479",
            "vehicleStatus": "Deleted",
            "deletedAge": 87
         },
         "leadDetails":          {
            "adPrintDetails": [{"dateTime": "01/10/2016 04:38 PM CST"}],
            "mapViewDetails": [{"dateTime": "01/29/2016 05:39 PM CST"}],
            "clickThruDetails": [],
            "emailDetails": [],
            "chatDetails": []
         },
         "contactSummary":          {
            "searchViews": 1924,
            "detailViews": 26,
            "conversionRate": 1.35,
            "totalContacts": 3
         }
      },
      {
         "classifiedAdId": "655007604",
         "message": "Listing details not found."
      }
   ]
}}
Test
Method Type: 
GET