Alerts
Estimate the volume of an alert
Estimates the notifications an alert with these criteria would send per day and per hour once running, from the matching properties that arrived over the last 30 days. A newly saved alert also notifies, in its first days, the matching properties already on the market; this estimate leaves them out. A rough figure that counts new properties only. Not billed.
Authorization
apiKey X-API-KEY<token>
Value for the X-API-KEY header parameter.
In: header
Request Body
application/json
The criteria of the alert to estimate.
Response Body
application/json
curl -X POST "https://example.com/alerts/forecast" \ -H "Content-Type: application/json" \ -d '{ "criteria": { "property": { "type": { "in": [ "FLAT" ] }, "transaction": { "type": "RENT" }, "pricing": { "displayed": { "lte": 2000 } }, "locations": { "countryCode": "FR", "in": { "uniqueCodes": [ "75056" ] } } } } }'{ "windowDays": 30, "total": 2520, "perDay": { "average": 13.7, "low": 6, "high": 24 }, "perHour": { "average": 13.7, "low": 6, "high": 24 }}