Website logo

Retrieves your property agent report

Retrieves the Property Agent report for the authenticated user.

URL: https://api.trademe.co.nz/v1/mytrademe/propertyagentreport/{filter}.{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

filter String (required)

The range for the report.

CurrentAll the current listings.
Last45DaysListings in the last 45 days.
Last7DaysListings in the last 7 days.
AllThe same as Last45Days
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<PropertyAgentReport>

The Property Agent report data.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <PropertyAgentReportLine> or null InnerList
AgentReference String or null AgentReference
Title String or null Title
Views Integer Views
StartDate DateTime StartDate
EndDate DateTime EndDate
Category String or null Category
Agent String or null Agent
Address String or null Address
Suburb String or null Suburb
Price String or null Price
Watchers Integer Watchers
Enquiries Integer Enquiries
OpenHomes Integer OpenHomes
IsFeatured Boolean IsFeatured
TradeMeReference String or null TradeMeReference

Example XML Response (switch to JSON) 

<PropertyAgentReport xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <PropertyAgentReportLine>
      <AgentReference>ABC</AgentReference>
      <Title>ABC</Title>
      <Views>123</Views>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <Category>ABC</Category>
      <Agent>ABC</Agent>
      <Address>ABC</Address>
      <Suburb>ABC</Suburb>
      <Price>ABC</Price>
      <Watchers>123</Watchers>
      <Enquiries>123</Enquiries>
      <OpenHomes>123</OpenHomes>
      <IsFeatured>false</IsFeatured>
      <TradeMeReference>ABC</TradeMeReference>
    </PropertyAgentReportLine>
    <PropertyAgentReportLine>
      <AgentReference>ABC</AgentReference>
      <Title>ABC</Title>
      <Views>123</Views>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <Category>ABC</Category>
      <Agent>ABC</Agent>
      <Address>ABC</Address>
      <Suburb>ABC</Suburb>
      <Price>ABC</Price>
      <Watchers>123</Watchers>
      <Enquiries>123</Enquiries>
      <OpenHomes>123</OpenHomes>
      <IsFeatured>false</IsFeatured>
      <TradeMeReference>ABC</TradeMeReference>
    </PropertyAgentReportLine>
  </List>
</PropertyAgentReport>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "AgentReference": "ABC",
      "Title": "ABC",
      "Views": 123,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "Category": "ABC",
      "Agent": "ABC",
      "Address": "ABC",
      "Suburb": "ABC",
      "Price": "ABC",
      "Watchers": 123,
      "Enquiries": 123,
      "OpenHomes": 123,
      "IsFeatured": false,
      "TradeMeReference": "ABC"
    },
    {
      "AgentReference": "ABC",
      "Title": "ABC",
      "Views": 123,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "Category": "ABC",
      "Agent": "ABC",
      "Address": "ABC",
      "Suburb": "ABC",
      "Price": "ABC",
      "Watchers": 123,
      "Enquiries": 123,
      "OpenHomes": 123,
      "IsFeatured": false,
      "TradeMeReference": "ABC"
    }
  ]
}