Properties Alerts
Get the search criteria of a Propertyalert
System
- System
Properties
- Samples
- Properties
- Reporting
- Properties Alerts
- PUTCreate a new alert for this Property search
- GETGet the search criteria of a Propertyalert
- DELDeactivate a Property search alert
- PATCHUpdate the search criteria of a Property alert
- GETGet all your Property alerts
- GETActivate a Property search alert
- GETGet history of match properties by its saved search flxId
- PUT
Adverts
- Samples
- Reporting
- Adverts
- Adverts Alerts
RealEstate Companies
- Agency details
Properties Alerts
Get the search criteria of a Propertyalert
Get the search criteria of a Property alert by its id (alertId)
GET
/
v2
/
protected
/
properties
/
search
/
alerts
/
{alertId}
curl --request GET \
--url https://api.fluximmo.io/v2/protected/properties/search/alerts/{alertId} \
--header 'x-api-key: <api-key>'{
"data": {
"search_query": {
"filterProperty": {
"adverts": [],
"habitation": {
"bathroomCount": {
"max": 123,
"min": 123
},
"bedroomCount": {
"max": 123,
"min": 123
},
"characteristics": {
"hasAlarm": true,
"hasBalcony": true,
"hasCellar": true,
"hasConcierge": true,
"hasDigicode": true,
"hasFireplace": true,
"hasGarage": true,
"hasGarden": true,
"hasGrenier": true,
"hasInterphone": true,
"hasJacuzzi": true,
"hasLand": true,
"hasLift": true,
"hasMezzanine": true,
"hasParking": true,
"hasPool": true,
"hasTerrace": true,
"hasVisAVis": true,
"isPeaceful": true
},
"climate": {
"epcClimate": [],
"epcClimateScore": {
"max": 123,
"min": 123
},
"epcEnergy": [],
"epcEnergyScore": {
"max": 123,
"min": 123
},
"epcClimateDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"epcEnergyDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"features": {
"exposure": [],
"furniture": [],
"propertyFloor": {
"max": 123,
"min": 123
},
"propertyTotalFloor": {
"max": 123,
"min": 123
},
"constructionMaterials": [],
"glazingTypes": [],
"hasThroughExposure": true,
"viewOns": [],
"viewTypes": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": [
{
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
}
],
"roomCount": {
"max": 123,
"min": 123
},
"surface": {
"balconies": {
"max": 123,
"min": 123
},
"floorSpace": {
"max": 123,
"min": 123
},
"gardens": {
"max": 123,
"min": 123
},
"groundFloor": {
"max": 123,
"min": 123
},
"kitchen": {
"max": 123,
"min": 123
},
"livingSpace": {
"max": 123,
"min": 123
},
"livingroom": {
"max": 123,
"min": 123
},
"terraces": {
"max": 123,
"min": 123
},
"total": {
"max": 123,
"min": 123
}
},
"type": "PROPERTY_TYPE_T1_T2",
"wcCount": {
"max": 123,
"min": 123
}
},
"isUrgent": true,
"land": {
"canConstruct": true,
"isServiced": true,
"surface": {
"max": 123,
"min": 123
},
"surfaceConstructable": {
"max": 123,
"min": 123
},
"type": [],
"haveBuildingPermit": true,
"haveElectricity": true,
"haveTelecom": true,
"haveWater": true
},
"location": [],
"meta": {
"firstSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"isTotallyOffline": true,
"lastPublishedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastUpdatedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"price": {
"currency": [],
"initial": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"isAuction": true,
"latest": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"scope": [],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"variation": []
},
"process": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"hasAnomaly": true,
"offer": []
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"match": [
"ALERT_MATCH_CREATED"
],
"context": {
"metadata": {}
},
"activated": true,
"alert_id": "<string>"
}
}Authorizations
Path Parameters
Response
200
application/json
Example:
[]
An anomaly or incoherence have been detected
Is the advert exclusive to the seller
Example:
[]
Available options:
HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIX, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN Example:
[]
Available options:
HEAT_DETAIL_UNKNOWN, HEAT_DETAIL_FLOOR, HEAT_DETAIL_CEILING, HEAT_DETAIL_FIREPLACE, HEAT_DETAIL_INSERT, HEAT_DETAIL_AIR_CON, HEAT_DETAIL_REVERSIBLE_AIR_CON, HEAT_DETAIL_RADIANTS_TUBES, HEAT_DETAIL_RADIATOR, HEAT_DETAIL_SHEAHS, HEAT_DETAIL_CONVECTOR Example:
[]
Available options:
HEATING_UNKNOWN, HEATING_FUEL_OIL, HEATING_ELECTRICAL, HEATING_GAS, HEATING_BIOMASS, HEATING_SOLAR, HEATING_GEOTHERMAL, HEATING_WOOD, HEATING_HEAT_PUMP, HEATING_PELLET, HEATING_CANADIAN_WELL, HEATING_COAL Example:
[]
Available options:
PROPERTY_TYPE_UNKNOWN, PROPERTY_TYPE_STUDIO, PROPERTY_TYPE_T1, PROPERTY_TYPE_T1_T2, PROPERTY_TYPE_T2, PROPERTY_TYPE_T2_T3, PROPERTY_TYPE_T3, PROPERTY_TYPE_T3_4, PROPERTY_TYPE_T4, PROPERTY_TYPE_T4_5, PROPERTY_TYPE_T5_MORE, PROPERTY_TYPE_LOFT, PROPERTY_TYPE_DUPLEX, PROPERTY_TYPE_OTHER_APARTMENT_TYPE, PROPERTY_TYPE_INDIVIDUAL, PROPERTY_TYPE_ONE_SIDE_TERRACED, PROPERTY_TYPE_TWO_SIDE_TERRACED, PROPERTY_TYPE_SINGLE_STOREY, PROPERTY_TYPE_TRADITIONAL, PROPERTY_TYPE_CONTEMPORARY, PROPERTY_TYPE_BOURGEOIS, PROPERTY_TYPE_VILLA, PROPERTY_TYPE_MANOR, PROPERTY_TYPE_CASTLE, PROPERTY_TYPE_FARM, PROPERTY_TYPE_MAS, PROPERTY_TYPE_BASTIDE, PROPERTY_TYPE_CHALET, PROPERTY_TYPE_ANCIENT, PROPERTY_TYPE_HERITAGE_LISTED, PROPERTY_TYPE_BUNGALOW Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST Example:
[]
Example:
[]
Available options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING Example:
[]
Available options:
CURRENCY_EUR, CURRENCY_USD Example:
[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL Example:
[]
Example:
[]
Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED Example:
[]
Available options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING Example:
["CLASS_HOUSE"]
An anomaly or incoherence have been detected
Available options:
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS Example:
[]
Search terms for full text search. We'll search in title, description, and keywords for terms similar to these (typically, we'll use a fuzzy search).
Search terms for keyword search. We'll search in title, description, and keywords for exact matches to these terms (typically, we'll use a term search).
Available options:
ALERT_MATCH_UNKNOWN, ALERT_MATCH_CREATED, ALERT_MATCH_MERGED Example:
["ALERT_MATCH_CREATED"]
Any metadata associated to this query. This will be returned in the response, and can be used to store any data you want to associate to this query. For example, you can store the ID of the user who created this query, or the ID of the alert that triggered this query.
Was this page helpful?
curl --request GET \
--url https://api.fluximmo.io/v2/protected/properties/search/alerts/{alertId} \
--header 'x-api-key: <api-key>'{
"data": {
"search_query": {
"filterProperty": {
"adverts": [],
"habitation": {
"bathroomCount": {
"max": 123,
"min": 123
},
"bedroomCount": {
"max": 123,
"min": 123
},
"characteristics": {
"hasAlarm": true,
"hasBalcony": true,
"hasCellar": true,
"hasConcierge": true,
"hasDigicode": true,
"hasFireplace": true,
"hasGarage": true,
"hasGarden": true,
"hasGrenier": true,
"hasInterphone": true,
"hasJacuzzi": true,
"hasLand": true,
"hasLift": true,
"hasMezzanine": true,
"hasParking": true,
"hasPool": true,
"hasTerrace": true,
"hasVisAVis": true,
"isPeaceful": true
},
"climate": {
"epcClimate": [],
"epcClimateScore": {
"max": 123,
"min": 123
},
"epcEnergy": [],
"epcEnergyScore": {
"max": 123,
"min": 123
},
"epcClimateDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"epcEnergyDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"features": {
"exposure": [],
"furniture": [],
"propertyFloor": {
"max": 123,
"min": 123
},
"propertyTotalFloor": {
"max": 123,
"min": 123
},
"constructionMaterials": [],
"glazingTypes": [],
"hasThroughExposure": true,
"viewOns": [],
"viewTypes": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": [
{
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
}
],
"roomCount": {
"max": 123,
"min": 123
},
"surface": {
"balconies": {
"max": 123,
"min": 123
},
"floorSpace": {
"max": 123,
"min": 123
},
"gardens": {
"max": 123,
"min": 123
},
"groundFloor": {
"max": 123,
"min": 123
},
"kitchen": {
"max": 123,
"min": 123
},
"livingSpace": {
"max": 123,
"min": 123
},
"livingroom": {
"max": 123,
"min": 123
},
"terraces": {
"max": 123,
"min": 123
},
"total": {
"max": 123,
"min": 123
}
},
"type": "PROPERTY_TYPE_T1_T2",
"wcCount": {
"max": 123,
"min": 123
}
},
"isUrgent": true,
"land": {
"canConstruct": true,
"isServiced": true,
"surface": {
"max": 123,
"min": 123
},
"surfaceConstructable": {
"max": 123,
"min": 123
},
"type": [],
"haveBuildingPermit": true,
"haveElectricity": true,
"haveTelecom": true,
"haveWater": true
},
"location": [],
"meta": {
"firstSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"isTotallyOffline": true,
"lastPublishedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastUpdatedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"price": {
"currency": [],
"initial": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"isAuction": true,
"latest": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"scope": [],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"variation": []
},
"process": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"hasAnomaly": true,
"offer": []
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"match": [
"ALERT_MATCH_CREATED"
],
"context": {
"metadata": {}
},
"activated": true,
"alert_id": "<string>"
}
}