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

This method retrieves analytics and performance reports at the Dealer level on a given day or within a given month.

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/dealer
production https://api.cars.com/DealerMetricsService/1.0/rest/reports/contactdetails/dealer

Request

Request Data Formats
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
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
DealerContactDetails
Element Type Description
dealerDirectorySearches Integer Number of Dealer directory searches
srpViews Integer Number of SRP Views
vdpViews Integer Number of VDP Views
adPrintSummary AdPrintSummary See AdPrintSummary element description below
mapViewSummary MapViewSummary See MapViewSummary element description below
clickThruSummary ClickThruSummary See ClickThruSummary element description below
newEmailSummary NewEmailSummary See NewEmailSummary element description below
usedEmailSummary UsedEmailSummary See UsedEmailSummary element description below
newPhoneSummary NewPhoneSummary See NewPhoneSummary element description below
usedPhoneSummary UsedPhoneSummary See UsedPhoneSummary element description below
newChatSummary NewChatSummary See NewChatSummary element description below
usedChatSummary UsedChatSummary See UsedChatSummary element description below
drivDirContact Integer Driving Directions Page Views
textToDealer Integer Number of contacts by text to dealer
dealerEmail Integer Number of contacts by dealer email
dealerPhone Integer Number of Service Phone Contacts
AdPrintSummary
Element Type Description
adPrintsOverall Integer Overall total ad prints
countNew String Total new ad prints
countUsed String Total used ad prints
percentNew String Percentage of new ad prints
percentUsed String Percentage of used ad prints
MapViewSummary
Element Type Description
mapViewsOverall Integer Overall total map views
countNew String Total new map views
countUsed String Total used map views
percentNew String Percentage of new map views
percentUsed String Percentage of used map views
ClickThruSummary
Element Type Description
clickThrusOverall Integer Overall total click thrus
countNew String Total new click thrus
countUsed String Total used click thrus
percentNew String Percentage new click thrus
percentUsed String Percentage used click thrus
NewEmailSummary
Element Type Description
newEmailOverall Integer Total new email leads
UsedEmailSummary
Element Type Description
usedEmailOverall Integer Total used email leads
NewPhoneSummary
Element Type Description
newPhoneOverall Integer Total new phone leads
phoneListing List: PhoneListing Class description below
UsedPhoneSummary
Element Type Description
usedPhoneOverall Integer Total used phone leads
phoneListing List: PhoneListing Class description below
PhoneListing
Element Type Description
dateTimeReceived String Date and Time of call received
callersPhone String Caller's phone #
callersZip String Caller's zip code
callStatus String Call status
callDuration String Call duration
NewChatSummary
Element Type Description
newChatOverall Integer Total new chat leads
UsedChatSummary
Element Type Description
usedChatOverall Integer Total used chat leads
Response XML Example
<dealerContactDetails>
 <dealerDirectorySearches>1542</dealerDirectorySearches>
 <srpViews>411598</srpViews>
 <vdpViews>4921</vdpViews>
 <adPrintSummary>
    <adPrintsOverall>19</adPrintsOverall>
    <countNew>8</countNew>
    <countUsed>11</countUsed>
    <percentNew>42</percentNew>
    <percentUsed>58</percentUsed>
 </adPrintSummary>
 <mapViewSummary>
    <mapViewsOverall>80</mapViewsOverall>
    <countNew>20</countNew>
    <countUsed>55</countUsed>
    <percentNew>25</percentNew>
    <percentUsed>69</percentUsed>
 </mapViewSummary>
 <clickThruSummary>
    <clickThrusOverall>34</clickThrusOverall>
    <countNew>11</countNew>
    <countUsed>13</countUsed>
    <percentNew>32</percentNew>
    <percentUsed>38</percentUsed>
 </clickThruSummary>
 <newEmailSummary>
    <newEmailOverall>10</newEmailOverall>
 </newEmailSummary>
 <usedEmailSummary>
    <usedEmailOverall>20</usedEmailOverall>
 </usedEmailSummary>
 <newPhoneSummary>
    <newPhoneOverall>2</newPhoneOverall>
    <phoneListing>
     <dateTimeReceived>07/01/2014 03:41 PM CST</dateTimeReceived>
     <callersPhone>(484) 555-1272</callersPhone>
     <callersZip>19464</callersZip>
     <callStatus>COMPLETED</callStatus>
     <callDuration>7m 21s</callDuration>
    </phoneListing>
    <phoneListing>
     <dateTimeReceived>07/01/2014 04:16 PM CST</dateTimeReceived>
     <callersPhone>(703) 555-0805</callersPhone>
     <callersZip>22201</callersZip>
     <callStatus>COMPLETED</callStatus>
     <callDuration>4m 19s</callDuration>
    </phoneListing>
 </newPhoneSummary>
 <usedPhoneSummary>
    <usedPhoneOverall>2</usedPhoneOverall>
    <phoneListing>
     <dateTimeReceived>07/03/2014 02:45 PM CST</dateTimeReceived>
     <callersPhone>(443) 555-2163</callersPhone>
     <callersZip>21202</callersZip>
     <callStatus>COMPLETED</callStatus>
     <callDuration>2m 43s</callDuration>
    </phoneListing>
    <phoneListing>
     <dateTimeReceived>07/03/2014 02:43 PM CST</dateTimeReceived>
     <callersPhone>(443) 555-2163</callersPhone>
     <callersZip>21202</callersZip>
     <callStatus>COMPLETED</callStatus>
     <callDuration>1m 48s</callDuration>
    </phoneListing>
 </usedPhoneSummary>
 <newChatSummary>
    <newChatOverall>0</newChatOverall>
 </newChatSummary>
 <usedChatSummary>
    <usedChatOverall>7</usedChatOverall>
 </usedChatSummary>
 <drivDirContact>12</drivDirContact>
 <textToDealer>0</textToDealer>
 <dealerEmail>0</dealerEmail>
 <dealerPhone>0</dealerPhone>
</dealerContactDetails>
Response JSON example
{"DealerContactDetails": {
 "dealerDirectorySearches": 1542,
 "srpViews": 411598,
 "vdpViews": 4921,
 "adPrintSummary": {
  "adPrintsOverall": 19,
  "countNew": "8",
  "countUsed": "11",
  "percentNew": "42",
  "percentUsed": "58"
 },
 "mapViewSummary": {
  "mapViewsOverall": 80,
  "countNew": "20",
  "countUsed": "55",
  "percentNew": "25",
  "percentUsed": "69"
 },
 "clickThruSummary": {
  "clickThrusOverall": 34,
  "countNew": "11",
  "countUsed": "13",
  "percentNew": "32",
  "percentUsed": "38"
 },
 "newEmailSummary": {"newEmailOverall": 10},
 "usedEmailSummary": {"usedEmailOverall": 20},
 "newPhoneSummary":
 {
  "newPhoneOverall": 2,
  "phoneListing":
  [
   {
    "dateTimeReceived": "07/01/2014 03:41 PM CST",
    "callersPhone": "(484) 555-1272",
    "callersZip": "19464",
    "callStatus": "COMPLETED",
    "callDuration": "7m 21s"
   },
   {
    "dateTimeReceived": "07/01/2014 04:16 PM CST",
    "callersPhone": "(703) 555-0805",
    "callersZip": "22201",
    "callStatus": "COMPLETED",
    "callDuration": "4m 19s"
   }
  ]
 },
 "usedPhoneSummary":
 {
  "usedPhoneOverall": 2,
  "phoneListing":
  [
   {
    "dateTimeReceived": "07/03/2014 02:45 PM CST",
    "callersPhone": "(443) 555-2163",
    "callersZip": "21202",
    "callStatus": "COMPLETED",
    "callDuration": "2m 43s"
   },
   {
    "dateTimeReceived": "07/03/2014 02:43 PM CST",
    "callersPhone": "(443) 555-2163",
    "callersZip": "21202",
    "callStatus": "COMPLETED",
    "callDuration": "1m 48s"
   }
  ]
 },
 "newChatSummary": {"newChatOverall": 0},
 "usedChatSummary": {"usedChatOverall": 7},
 "drivDirContact": 12,
 "textToDealer": 0,
 "dealerEmail": 0,
 "dealerPhone": 0
}}
Test
Method Type: 
GET
Endpoint URI: 
https://api-st.cars.com/DealerMetricsService/1.0/rest/reports/contactdetails/dealer