Website logo

Gets the counts for listing statistics from homes

Retrieves the counts for listing statistics from homes

URL: https://api.trademe.co.nz/v1/Property/Office/{officeMemberId}/HomesListingStatistics/{listingId}.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

officeMemberId String (required)

listingId String (required)

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

from_date String (optional)

to_date String (optional)

Returns

<HomesListingStats>

A response containing Homes listing ID and list of counts per day.

ListingId Integer

TM Listing ID
HomesListingId String or null

Homes Listing ID
TotalEmailEnquiryCount Integer

Total email enquiry count
TotalClickToCallCount Integer

Total click to call count
TotalViewCount Integer

Total view count
EmailEnquiryCount Integer

Email enquiry count within date range
ClickToCallCount Integer

Click to call count within date range
ViewCount Integer

View count within date range
DailyActivity Collection of <DailyListingActivity> or null

List of view counts per date
Day DateTime

The date of the day when these statistics occurred
NewViewCount Integer

The number of times the listing was viewed on this day.

Example XML Response (switch to JSON) 

<HomesListingStats xmlns="http://api.trademe.co.nz/v1">
  <ListingId>123</ListingId>
  <HomesListingId>ABC</HomesListingId>
  <TotalEmailEnquiryCount>123</TotalEmailEnquiryCount>
  <TotalClickToCallCount>123</TotalClickToCallCount>
  <TotalViewCount>123</TotalViewCount>
  <EmailEnquiryCount>123</EmailEnquiryCount>
  <ClickToCallCount>123</ClickToCallCount>
  <ViewCount>123</ViewCount>
  <DailyActivity>
    <DailyListingActivity>
      <Day>2018-01-01T00:00:00Z</Day>
      <NewViewCount>123</NewViewCount>
    </DailyListingActivity>
    <DailyListingActivity>
      <Day>2018-01-01T00:00:00Z</Day>
      <NewViewCount>123</NewViewCount>
    </DailyListingActivity>
  </DailyActivity>
</HomesListingStats>

Example JSON Response (switch to XML) 

{
  "ListingId": 123,
  "HomesListingId": "ABC",
  "TotalEmailEnquiryCount": 123,
  "TotalClickToCallCount": 123,
  "TotalViewCount": 123,
  "EmailEnquiryCount": 123,
  "ClickToCallCount": 123,
  "ViewCount": 123,
  "DailyActivity": [
    {
      "Day": "\/Date(1514764800)\/",
      "NewViewCount": 123
    },
    {
      "Day": "\/Date(1514764800)\/",
      "NewViewCount": 123
    }
  ]
}