Website logo

Get office listing statistics

Returns listing statistics for all current listings listed by the office, including a break up by day and suburb.

URL: https://api.trademe.co.nz/v1/Property/Office/ListingStatistics.{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

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

Query String parameters

days Integer (optional)

The number of days of statistical data to retrieve, ending yesterday. Defaults to 30. Minimum 1, Maximum 30

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.

Returns

<ListingStatisticsPagedCollection>

A paged collection of listing statistics

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.

Page Integer

The index of the current page of results (starts at 1).

PageSize Integer

The number of results in the current page.

List Collection of <ListingStatistics> or null

A list of the results in the current page.

ListingId Long Integer

The ID of the listing.

WatcherCount Integer

The number watchers for this listing.

EnquiryCount Integer

The number of enquiries about this listing.

IsSuperFeatured Boolean

Is this a super-featured listing?

DailyStatistics Collection of <DailyListingStatistics> or null

The daily statistics for this live listing for the specified number of days

Day DateTime

The date of the day when these statistics occurred

NewViewCount Integer

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

PerSuburbWatchersStatistics Collection of <PerSuburbListingStatistics> or null

The current count of watchers for this listing by suburb and region

CurrentCount Integer

Count of either views or watchers

SuburbId Integer

Suburb Id of the view or watcher

SuburbName String or null

Suburb name of the view or watcher

RegionId Integer

Region Id of the view or watcher

RegionName String or null

Region name of the view or watcher

GSRegionId Integer

GeoSpatial Region Id of the view or watcher

PerSuburbViewsStatistics Collection of <PerSuburbListingStatistics> or null

The current count of views for this listing by suburb and region

(This type has already been defined)
ClickToCallCount Integer

The current count of click to calls for this listing

TotalPages Integer or null

Total number of pages available

Example XML Response (switch to JSON)

<ListingStatisticsPagedCollection xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <ListingStatistics>
      <ListingId>123</ListingId>
      <WatcherCount>123</WatcherCount>
      <EnquiryCount>123</EnquiryCount>
      <IsSuperFeatured>false</IsSuperFeatured>
      <DailyStatistics>
        <DailyListingStatistics>
          <Day>2018-01-01T00:00:00Z</Day>
          <NewViewCount>123</NewViewCount>
        </DailyListingStatistics>
        <DailyListingStatistics>
          <Day>2018-01-01T00:00:00Z</Day>
          <NewViewCount>123</NewViewCount>
        </DailyListingStatistics>
      </DailyStatistics>
      <PerSuburbWatchersStatistics>
        <PerSuburbListingStatistics>
          <CurrentCount>123</CurrentCount>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <RegionId>123</RegionId>
          <RegionName>ABC</RegionName>
          <GSRegionId>123</GSRegionId>
        </PerSuburbListingStatistics>
        <PerSuburbListingStatistics>
          <CurrentCount>123</CurrentCount>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <RegionId>123</RegionId>
          <RegionName>ABC</RegionName>
          <GSRegionId>123</GSRegionId>
        </PerSuburbListingStatistics>
      </PerSuburbWatchersStatistics>
      <PerSuburbViewsStatistics>
        <PerSuburbListingStatistics />
        <PerSuburbListingStatistics />
      </PerSuburbViewsStatistics>
      <ClickToCallCount>123</ClickToCallCount>
    </ListingStatistics>
    <ListingStatistics>
      <ListingId>123</ListingId>
      <WatcherCount>123</WatcherCount>
      <EnquiryCount>123</EnquiryCount>
      <IsSuperFeatured>false</IsSuperFeatured>
      <DailyStatistics>
        <DailyListingStatistics>
          <Day>2018-01-01T00:00:00Z</Day>
          <NewViewCount>123</NewViewCount>
        </DailyListingStatistics>
        <DailyListingStatistics>
          <Day>2018-01-01T00:00:00Z</Day>
          <NewViewCount>123</NewViewCount>
        </DailyListingStatistics>
      </DailyStatistics>
      <PerSuburbWatchersStatistics>
        <PerSuburbListingStatistics>
          <CurrentCount>123</CurrentCount>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <RegionId>123</RegionId>
          <RegionName>ABC</RegionName>
          <GSRegionId>123</GSRegionId>
        </PerSuburbListingStatistics>
        <PerSuburbListingStatistics>
          <CurrentCount>123</CurrentCount>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <RegionId>123</RegionId>
          <RegionName>ABC</RegionName>
          <GSRegionId>123</GSRegionId>
        </PerSuburbListingStatistics>
      </PerSuburbWatchersStatistics>
      <PerSuburbViewsStatistics>
        <PerSuburbListingStatistics />
        <PerSuburbListingStatistics />
      </PerSuburbViewsStatistics>
      <ClickToCallCount>123</ClickToCallCount>
    </ListingStatistics>
  </List>
  <TotalPages>123</TotalPages>
</ListingStatisticsPagedCollection>

Example JSON Response (switch to XML)

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "ListingId": 123,
      "WatcherCount": 123,
      "EnquiryCount": 123,
      "IsSuperFeatured": false,
      "DailyStatistics": [
        {
          "Day": "\/Date(1514764800)\/",
          "NewViewCount": 123
        },
        {
          "Day": "\/Date(1514764800)\/",
          "NewViewCount": 123
        }
      ],
      "PerSuburbWatchersStatistics": [
        {
          "CurrentCount": 123,
          "SuburbId": 123,
          "SuburbName": "ABC",
          "RegionId": 123,
          "RegionName": "ABC",
          "GSRegionId": 123
        },
        {
          "CurrentCount": 123,
          "SuburbId": 123,
          "SuburbName": "ABC",
          "RegionId": 123,
          "RegionName": "ABC",
          "GSRegionId": 123
        }
      ],
      "PerSuburbViewsStatistics": [
        {
        },
        {
        }
      ],
      "ClickToCallCount": 123
    },
    {
      "ListingId": 123,
      "WatcherCount": 123,
      "EnquiryCount": 123,
      "IsSuperFeatured": false,
      "DailyStatistics": [
        {
          "Day": "\/Date(1514764800)\/",
          "NewViewCount": 123
        },
        {
          "Day": "\/Date(1514764800)\/",
          "NewViewCount": 123
        }
      ],
      "PerSuburbWatchersStatistics": [
        {
          "CurrentCount": 123,
          "SuburbId": 123,
          "SuburbName": "ABC",
          "RegionId": 123,
          "RegionName": "ABC",
          "GSRegionId": 123
        },
        {
          "CurrentCount": 123,
          "SuburbId": 123,
          "SuburbName": "ABC",
          "RegionId": 123,
          "RegionName": "ABC",
          "GSRegionId": 123
        }
      ],
      "PerSuburbViewsStatistics": [
        {
        },
        {
        }
      ],
      "ClickToCallCount": 123
    }
  ],
  "TotalPages": 123
}