Agencies
Retrieves statistics for a specific agency.
get/v1/agencies/{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
Agency identifier
Query parameters
timePeriod'last7Days' | 'last90Days' | 'wholeCampaign'
Defines StatisticsTimePeriod
Period to report on, Valid values are: last7Days, last90Days, wholeCampaign. Default is last7Days.
statusFilter'live' | 'liveAndArchived'
Which listings to filter based on status in lifecycle
Status to filter, Valid values are: Live, LiveAndArchived. Default is LiveAndArchived
channel'residential' | 'commercial' | 'business'
Channel of the listing
Filter statistics for the given channel
pageNumberinteger
Page number
pageSizeinteger
Page size
Response
OK
Changes
No recorded changes to this operation across all 18 revisions of this API.