Website logo

Retrieves job agent six month summary

Retrieves a six month summary of a job agent's activity

URL: https://api.trademe.co.nz/v1/Jobs/Members/{memberId}/Agent/Summary.{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)

The member id to retrieve the summary for. Must be the authenticated member

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

Returns

Collection of <JobAgentMonthSummary>

A collection of monthly summary objects

MonthsAgo Integer

Number of months ago where the current month is 0

Month DateTime

Date of the first day of the month

ListingCount Integer

Number of listings started that month. Will be -1 if no data available for this agent.

ApplicationCount Integer

Number of applications across all listings that month. Will be -1 if no data available for this agent.

VisitCount Integer

Number of views across all listings that month. Will be -1 if no data available for this agent.

Example XML Response (switch to JSON)

<JobAgentMonthSummaryCollection xmlns="http://api.trademe.co.nz/v1">
  <JobAgentMonthSummary>
    <MonthsAgo>123</MonthsAgo>
    <Month>2018-01-01T00:00:00Z</Month>
    <ListingCount>123</ListingCount>
    <ApplicationCount>123</ApplicationCount>
    <VisitCount>123</VisitCount>
  </JobAgentMonthSummary>
  <JobAgentMonthSummary>
    <MonthsAgo>123</MonthsAgo>
    <Month>2018-01-01T00:00:00Z</Month>
    <ListingCount>123</ListingCount>
    <ApplicationCount>123</ApplicationCount>
    <VisitCount>123</VisitCount>
  </JobAgentMonthSummary>
</JobAgentMonthSummaryCollection>

Example JSON Response (switch to XML)

[
  {
    "MonthsAgo": 123,
    "Month": "\/Date(1514764800)\/",
    "ListingCount": 123,
    "ApplicationCount": 123,
    "VisitCount": 123
  },
  {
    "MonthsAgo": 123,
    "Month": "\/Date(1514764800)\/",
    "ListingCount": 123,
    "ApplicationCount": 123,
    "VisitCount": 123
  }
]