Website logo

Get property agent live listing statistics

Retrieve a list of a property agent's live listings, with some basic statistics for the agent's listings and their office's listings. This endpoint is available for all Trademe partner API accounts however is rate limited to 100 calls per hour per consumer

URL: https://api.trademe.co.nz/v1/Property/Agents/{memberId}/LiveListingStatistics.{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

memberId Integer (required)
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 statistics to retrieve, ending yesterday. Defaults to 30. Minimum 1, maximum 30

Returns

<AgentLiveListingStatistics>

AgentLiveListingStatistics

LiveListingStatistics Collection of <ListingStatistics> or null

A list of live listings for the property agent with some basic statistics.

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

OfficeDailyStatistics Collection of <OfficeDailyListingStatistics> or null

The daily statistics for the office's combined live listings for the specified number of days.

Day DateTime

The date of the day when these statistics occurred

ListingCount Integer

The number of listings the office had on this day.

NewViewCount Integer

The number of times the office's listings were viewed on this day.

Example XML Response (switch to JSON)

<AgentLiveListingStatistics xmlns="http://api.trademe.co.nz/v1">
  <LiveListingStatistics>
    <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>
  </LiveListingStatistics>
  <OfficeDailyStatistics>
    <OfficeDailyListingStatistics>
      <Day>2018-01-01T00:00:00Z</Day>
      <ListingCount>123</ListingCount>
      <NewViewCount>123</NewViewCount>
    </OfficeDailyListingStatistics>
    <OfficeDailyListingStatistics>
      <Day>2018-01-01T00:00:00Z</Day>
      <ListingCount>123</ListingCount>
      <NewViewCount>123</NewViewCount>
    </OfficeDailyListingStatistics>
  </OfficeDailyStatistics>
</AgentLiveListingStatistics>

Example JSON Response (switch to XML)

{
  "LiveListingStatistics": [
    {
      "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
    }
  ],
  "OfficeDailyStatistics": [
    {
      "Day": "\/Date(1514764800)\/",
      "ListingCount": 123,
      "NewViewCount": 123
    },
    {
      "Day": "\/Date(1514764800)\/",
      "ListingCount": 123,
      "NewViewCount": 123
    }
  ]
}