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 31. Ignored if from_date and to_date are provided.
from_date	String (optional)	Start date (yyyy-MM-dd) for date range query. Must be provided with to_date. Maximum 31-day range.
page	Integer (optional)	The page number of the set of results to return, starting from 1. Defaults to 1.
to_date	String (optional)	End date (yyyy-MM-dd) for date range query. Must be provided with from_date. Maximum 31-day range.

Returns

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

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.
NewImpressionsCount	Integer	The number of new impressions for this listing 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

MemberIds

Collection of Integer or null

a listing can be assign to many members

GlobalPropertyNetworkStatistics

<GlobalPropertyNetwork> or null

global property network statistics

ReaUrl	String or null	rea url
RealtorUrl	String or null	realtor url
HousingUrl	String or null	housing url

ImpressionsCount

Integer

The number of impressions for this listing

ImpressionsInPeriod

Integer

The number of impressions for this listing in the specified period

ImpressionsCountAvgPerDay

Integer

The number of impressions count average per day 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>
          <NewImpressionsCount>123</NewImpressionsCount>
        </DailyListingStatistics>
        <DailyListingStatistics>
          <Day>2018-01-01T00:00:00Z</Day>
          <NewViewCount>123</NewViewCount>
          <NewImpressionsCount>123</NewImpressionsCount>
        </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>
      <MemberIds>
        <int>123</int>
        <int>123</int>
      </MemberIds>
      <GlobalPropertyNetworkStatistics>
        <ReaUrl>ABC</ReaUrl>
        <RealtorUrl>ABC</RealtorUrl>
        <HousingUrl>ABC</HousingUrl>
      </GlobalPropertyNetworkStatistics>
      <ImpressionsCount>123</ImpressionsCount>
      <ImpressionsInPeriod>123</ImpressionsInPeriod>
      <ImpressionsCountAvgPerDay>123</ImpressionsCountAvgPerDay>
    </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>
          <NewImpressionsCount>123</NewImpressionsCount>
        </DailyListingStatistics>
        <DailyListingStatistics>
          <Day>2018-01-01T00:00:00Z</Day>
          <NewViewCount>123</NewViewCount>
          <NewImpressionsCount>123</NewImpressionsCount>
        </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>
      <MemberIds>
        <int>123</int>
        <int>123</int>
      </MemberIds>
      <GlobalPropertyNetworkStatistics>
        <ReaUrl>ABC</ReaUrl>
        <RealtorUrl>ABC</RealtorUrl>
        <HousingUrl>ABC</HousingUrl>
      </GlobalPropertyNetworkStatistics>
      <ImpressionsCount>123</ImpressionsCount>
      <ImpressionsInPeriod>123</ImpressionsInPeriod>
      <ImpressionsCountAvgPerDay>123</ImpressionsCountAvgPerDay>
    </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,
          "NewImpressionsCount": 123
        },
        {
          "Day": "\/Date(1514764800)\/",
          "NewViewCount": 123,
          "NewImpressionsCount": 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,
      "MemberIds": [
        123,
        123
      ],
      "GlobalPropertyNetworkStatistics": {
        "ReaUrl": "ABC",
        "RealtorUrl": "ABC",
        "HousingUrl": "ABC"
      },
      "ImpressionsCount": 123,
      "ImpressionsInPeriod": 123,
      "ImpressionsCountAvgPerDay": 123
    },
    {
      "ListingId": 123,
      "WatcherCount": 123,
      "EnquiryCount": 123,
      "IsSuperFeatured": false,
      "DailyStatistics": [
        {
          "Day": "\/Date(1514764800)\/",
          "NewViewCount": 123,
          "NewImpressionsCount": 123
        },
        {
          "Day": "\/Date(1514764800)\/",
          "NewViewCount": 123,
          "NewImpressionsCount": 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,
      "MemberIds": [
        123,
        123
      ],
      "GlobalPropertyNetworkStatistics": {
        "ReaUrl": "ABC",
        "RealtorUrl": "ABC",
        "HousingUrl": "ABC"
      },
      "ImpressionsCount": 123,
      "ImpressionsInPeriod": 123,
      "ImpressionsCountAvgPerDay": 123
    }
  ],
  "TotalPages": 123
}