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

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 <PropertyAgentReportLine> or null

A list of the results in the current page.
AgentReference String or null

The agent's reference for the listing.
Title String or null

The title used for the listing.
Views Integer

The number of views on the listing.
StartDate DateTime

The UTC start date of the listing.
EndDate DateTime

The UTC end date of the listing.
Category String or null

The category of the listing.
Agent String or null

The agent for the property.
Address String or null

The address to display.
Suburb String or null

The suburb name for the property.
Price String or null

The price description.
Watchers Integer

The number of views on the property.
Enquiries Integer

The number of enquiries on the property.
OpenHomes Integer

The number of open homes.
IsFeatured Boolean

Indicates whether the property is featured.
TradeMeReference String or null

The Trade Me property reference.

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"
    }
  ]
}