Website logo

Retrieves job agent report

Retrieves a report of the job agent's listings

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

memberId Integer (required)

The member id to retrieve the report for. Must be the authenticated member
filter String (required)

The range for the report.

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

Returns

<JobAgentReport>

The job agent report data.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <JobAgentReportLine> or null InnerList
ListingId Integer ListingId
AgentReference String or null AgentReference
Title String or null Title
District String or null District
Region String or null Region
Views Integer Views
StartDate DateTime StartDate
EndDate DateTime EndDate
Category String or null Category
CompanyName String or null CompanyName
Applications Integer Applications
IsFeatured Boolean IsFeatured
ClicksToApply Integer ClicksToApply

Example XML Response (switch to JSON) 

<JobAgentReport xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <JobAgentReportLine>
      <ListingId>123</ListingId>
      <AgentReference>ABC</AgentReference>
      <Title>ABC</Title>
      <District>ABC</District>
      <Region>ABC</Region>
      <Views>123</Views>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <Category>ABC</Category>
      <CompanyName>ABC</CompanyName>
      <Applications>123</Applications>
      <IsFeatured>false</IsFeatured>
      <ClicksToApply>123</ClicksToApply>
    </JobAgentReportLine>
    <JobAgentReportLine>
      <ListingId>123</ListingId>
      <AgentReference>ABC</AgentReference>
      <Title>ABC</Title>
      <District>ABC</District>
      <Region>ABC</Region>
      <Views>123</Views>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <Category>ABC</Category>
      <CompanyName>ABC</CompanyName>
      <Applications>123</Applications>
      <IsFeatured>false</IsFeatured>
      <ClicksToApply>123</ClicksToApply>
    </JobAgentReportLine>
  </List>
</JobAgentReport>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "ListingId": 123,
      "AgentReference": "ABC",
      "Title": "ABC",
      "District": "ABC",
      "Region": "ABC",
      "Views": 123,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "Category": "ABC",
      "CompanyName": "ABC",
      "Applications": 123,
      "IsFeatured": false,
      "ClicksToApply": 123
    },
    {
      "ListingId": 123,
      "AgentReference": "ABC",
      "Title": "ABC",
      "District": "ABC",
      "Region": "ABC",
      "Views": 123,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "Category": "ABC",
      "CompanyName": "ABC",
      "Applications": 123,
      "IsFeatured": false,
      "ClicksToApply": 123
    }
  ]
}