Listings
List engagement for all listings
GET
https://api.ruuster.com/v1/properties/engagementThe engagement numbers for all your listings in one paged call, ranked by views, favorites, tour requests or contact requests.
- Authentication:
x-api-keyandx-emailheaders of an owner or admin - Rate limit: 120 requests per minute per key
Use it instead of one Get listing engagement call per listing.
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
from |
date | 30 days before to |
First day, YYYY-MM-DD in America/Chicago, included |
to |
date | today | Day after the last day, YYYY-MM-DD, excluded |
granularity |
string | week |
day, week or month. With day, each listing also carries a series |
status |
string | active |
active, pending, closed or all, as for List listings |
sort |
string | views |
views, favorites, tourRequests or contactAgentClicks, highest first |
cursor |
string | meta.nextCursor from the previous page. Omit for the first page |
|
limit |
integer | 100 |
Rows per page, 1 to 500 |
Response
data.properties lists your listings with propertyId, mlsRecordId, address, status and totals for the range, using the fields described on Get listing engagement. With granularity=day each item also has a series. meta.total and meta.nextCursor page through all your listings.