Agents
Retrieves stats for the listings of a given agent
get/v1/agents/{id}/statistics
Request
- Base URLhttps://api.domain.com.au
- Auth
- API key in header x-api-key
- or OAuth 2Authorization codehttps://auth.domain.com.au/v1/connect/authorizeClient credentialsToken URLhttps://auth.domain.com.au/v1/connect/tokenScopesapi_agencies_read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idinteger required
Agent identifier
Query parameters
timePeriod'last7Days' | 'last90Days' | 'wholeCampaign'
Defines StatisticsTimePeriod
The time period to show statistics for. Valid values are: last7Days, last90Days, wholeCampaign
statusFilter'live' | 'liveAndArchived'
Which listings to filter based on status in lifecycle
Listing filter
channel'residential' | 'commercial' | 'business'
Channel of the listing
Filter statistics for the given channel
pageNumberinteger
Page number for paginated results
pageSizeinteger
Page size for paginated results
Response
OK
Changes
No recorded changes to this operation across all 18 revisions of this API.