BulkPropertiesAlerts - Create multiple properties alert at the same time to lower the number of calls.
BulkPropertiesAlerts - Create multiple properties alert at the same time to lower the number of calls.
PUT
/
v2
/
alert
/
properties
/
_bulk
x-api-key
string
*
x-api-key
Required
string
API Key used to be authentified to these APIs. Please contact Fluximmo to get one
object
*
alerts
array
alerts
array
Authorizations
x-api-key
string
headerrequiredAPI Key used to be authentified to these APIs. Please contact Fluximmo to get one
Body
application/json
alerts
object[]
alerts.alert
object
alerts.alert.fullTexts
string[]
alerts.alert.keywords
string[]
alerts.alert.filterProperty
object
alerts.alert.filterProperty.indexTimestamp
object[]
alerts.alert.filterProperty.indexTimestamp.min
string
alerts.alert.filterProperty.indexTimestamp.max
string
alerts.alert.filterProperty.meta
object
alerts.alert.filterProperty.meta.firstSeenAt
object
alerts.alert.filterProperty.meta.firstSeenAt.min
string
alerts.alert.filterProperty.meta.firstSeenAt.max
string
alerts.alert.filterProperty.meta.lastUpdatedAt
object
alerts.alert.filterProperty.meta.lastUpdatedAt.min
string
alerts.alert.filterProperty.meta.lastUpdatedAt.max
string
alerts.alert.filterProperty.meta.firstPublishedAt
object
alerts.alert.filterProperty.meta.firstPublishedAt.min
string
alerts.alert.filterProperty.meta.firstPublishedAt.max
string
alerts.alert.filterProperty.meta.lastPublishedAt
object
alerts.alert.filterProperty.meta.lastPublishedAt.min
string
alerts.alert.filterProperty.meta.lastPublishedAt.max
string
alerts.alert.filterProperty.meta.lastSeenAt
object
alerts.alert.filterProperty.meta.lastSeenAt.min
string
alerts.alert.filterProperty.meta.lastSeenAt.max
string
alerts.alert.filterProperty.meta.isTotallyOffline
boolean
alerts.alert.filterProperty.tags
string[]
alerts.alert.filterProperty.isUrgent
boolean
alerts.alert.filterProperty.offer
object[]
alerts.alert.filterProperty.offer.type
enum<string>
default: OFFER_UNKNOWNAvailable options:
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS alerts.alert.filterProperty.offer.renting
object
alerts.alert.filterProperty.offer.renting.isSubLease
boolean
alerts.alert.filterProperty.offer.renting.isShortTerm
boolean
alerts.alert.filterProperty.offer.renting.isLongTerm
boolean
alerts.alert.filterProperty.offer.renting.isColocation
boolean
alerts.alert.filterProperty.offer.isCurrentlyOccupied
boolean
alerts.alert.filterProperty.type
enum<string>[]
Available options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING alerts.alert.filterProperty.process
enum<string>[]
Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED alerts.alert.filterProperty.price
object
alerts.alert.filterProperty.price.latest
object
alerts.alert.filterProperty.price.latest.value
object
alerts.alert.filterProperty.price.latest.value.min
integer
alerts.alert.filterProperty.price.latest.value.max
integer
alerts.alert.filterProperty.price.latest.valuePerArea
object
alerts.alert.filterProperty.price.latest.valuePerArea.min
integer
alerts.alert.filterProperty.price.latest.valuePerArea.max
integer
alerts.alert.filterProperty.price.latest.source
object
alerts.alert.filterProperty.price.latest.source.website
string
alerts.alert.filterProperty.price.latest.source.url
string
alerts.alert.filterProperty.price.latest.source.flxId
string
alerts.alert.filterProperty.price.lowest
object
alerts.alert.filterProperty.price.lowest.value
object
alerts.alert.filterProperty.price.lowest.value.min
integer
alerts.alert.filterProperty.price.lowest.value.max
integer
alerts.alert.filterProperty.price.lowest.valuePerArea
object
alerts.alert.filterProperty.price.lowest.valuePerArea.min
integer
alerts.alert.filterProperty.price.lowest.valuePerArea.max
integer
alerts.alert.filterProperty.price.lowest.source
object
alerts.alert.filterProperty.price.lowest.source.website
string
alerts.alert.filterProperty.price.lowest.source.url
string
alerts.alert.filterProperty.price.lowest.source.flxId
string
alerts.alert.filterProperty.price.highest
object
alerts.alert.filterProperty.price.highest.value
object
alerts.alert.filterProperty.price.highest.value.min
integer
alerts.alert.filterProperty.price.highest.value.max
integer
alerts.alert.filterProperty.price.highest.valuePerArea
object
alerts.alert.filterProperty.price.highest.valuePerArea.min
integer
alerts.alert.filterProperty.price.highest.valuePerArea.max
integer
alerts.alert.filterProperty.price.highest.source
object
alerts.alert.filterProperty.price.highest.source.website
string
alerts.alert.filterProperty.price.highest.source.url
string
alerts.alert.filterProperty.price.highest.source.flxId
string
alerts.alert.filterProperty.price.initial
object
alerts.alert.filterProperty.price.initial.value
object
alerts.alert.filterProperty.price.initial.value.min
integer
alerts.alert.filterProperty.price.initial.value.max
integer
alerts.alert.filterProperty.price.initial.valuePerArea
object
alerts.alert.filterProperty.price.initial.valuePerArea.min
integer
alerts.alert.filterProperty.price.initial.valuePerArea.max
integer
alerts.alert.filterProperty.price.initial.source
object
alerts.alert.filterProperty.price.initial.source.website
string
alerts.alert.filterProperty.price.initial.source.url
string
alerts.alert.filterProperty.price.initial.source.flxId
string
alerts.alert.filterProperty.price.warrantyDeposit
object
alerts.alert.filterProperty.price.warrantyDeposit.min
integer
alerts.alert.filterProperty.price.warrantyDeposit.max
integer
alerts.alert.filterProperty.price.charges
object
alerts.alert.filterProperty.price.charges.yearlyRentalFees
number
alerts.alert.filterProperty.price.charges.yearlyCondoniumFees
number
alerts.alert.filterProperty.price.charges.yearlyHeatingFees
number
alerts.alert.filterProperty.price.charges.yearlyElectricityFees
number
alerts.alert.filterProperty.price.charges.yearlyHousingTax
number
alerts.alert.filterProperty.price.charges.yearlyLivingTax
number
alerts.alert.filterProperty.price.charges.monthlyRentSupplement
number
alerts.alert.filterProperty.price.isAuction
boolean
alerts.alert.filterProperty.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL alerts.alert.filterProperty.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD alerts.alert.filterProperty.price.variation
object[]
alerts.alert.filterProperty.price.variation.sincePublished
object
alerts.alert.filterProperty.price.variation.sincePublished.min
number
alerts.alert.filterProperty.price.variation.sincePublished.max
number
alerts.alert.filterProperty.price.variation.sinceLastModified
object
alerts.alert.filterProperty.price.variation.sinceLastModified.min
number
alerts.alert.filterProperty.price.variation.sinceLastModified.max
number
alerts.alert.filterProperty.habitation
object
alerts.alert.filterProperty.habitation.type
enum<string>
default: PROPERTY_TYPE_UNKNOWNAvailable 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_INDIVIDUAL, 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, PROPERTY_TYPE_STUDETTE alerts.alert.filterProperty.habitation.roomCount
object
alerts.alert.filterProperty.habitation.roomCount.min
integer
alerts.alert.filterProperty.habitation.roomCount.max
integer
alerts.alert.filterProperty.habitation.bedroomCount
object
alerts.alert.filterProperty.habitation.bedroomCount.min
integer
alerts.alert.filterProperty.habitation.bedroomCount.max
integer
alerts.alert.filterProperty.habitation.bathroomCount
object
alerts.alert.filterProperty.habitation.bathroomCount.min
integer
alerts.alert.filterProperty.habitation.bathroomCount.max
integer
alerts.alert.filterProperty.habitation.wcCount
object
alerts.alert.filterProperty.habitation.wcCount.min
integer
alerts.alert.filterProperty.habitation.wcCount.max
integer
alerts.alert.filterProperty.habitation.roomsDetails
object[]
alerts.alert.filterProperty.habitation.roomsDetails.roomType
enum<string>
default: ROOM_TYPE_UNKNOWNAvailable options:
ROOM_TYPE_UNKNOWN, ROOM_TYPE_MASTER_BEDROOM, ROOM_TYPE_BEDROOM, ROOM_TYPE_KITCHEN, ROOM_TYPE_LIVING_ROOM, ROOM_TYPE_OFFICE alerts.alert.filterProperty.habitation.roomsDetails.area
number
alerts.alert.filterProperty.habitation.roomsDetails.floor
integer
alerts.alert.filterProperty.habitation.roomsDetails.contextInfo
string[]
alerts.alert.filterProperty.habitation.heatTypes
enum<string>[]
Available options:
HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIXED, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN alerts.alert.filterProperty.habitation.heatTypeDetails
enum<string>[]
Available options:
HEAT_DETAIL_UNKNOWN, HEAT_DETAIL_FLOOR, HEAT_DETAIL_CEILING, HEAT_DETAIL_FIREPLACE, HEAT_DETAIL_INSERT, HEAT_DETAIL_AIR_CON, HEAT_DETAIL_RADIANTS_TUBES, HEAT_DETAIL_RADIATOR, HEAT_DETAIL_SHEATHS, HEAT_DETAIL_CONVECTOR alerts.alert.filterProperty.habitation.heatings
enum<string>[]
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 alerts.alert.filterProperty.habitation.kitchenEquipped
enum<string>[]
Available options:
KITCHEN_UNKNOWN_EQUIPPED, KITCHEN_NON_EQUIPPED, KITCHEN_PARTIALLY_EQUIPPED, KITCHEN_FULLY_EQUIPPED, KITCHEN_FURNISHED, KITCHEN_NAKED, KITCHEN_EQUIPPED_FURNISHED alerts.alert.filterProperty.habitation.features
object
alerts.alert.filterProperty.habitation.features.propertyTotalFloor
object
alerts.alert.filterProperty.habitation.features.propertyTotalFloor.min
integer
alerts.alert.filterProperty.habitation.features.propertyTotalFloor.max
integer
alerts.alert.filterProperty.habitation.features.propertyFloor
object
alerts.alert.filterProperty.habitation.features.propertyFloor.min
integer
alerts.alert.filterProperty.habitation.features.propertyFloor.max
integer
alerts.alert.filterProperty.habitation.features.viewTypes
enum<string>[]
Available options:
VIEW_TYPE_UNKNOWN, VIEW_TYPE_GLIMPSE, VIEW_TYPE_PANORAMIC, VIEW_TYPE_CLEAR, VIEW_TYPE_EXCEPTIONAL, VIEW_TYPE_DOMINANT alerts.alert.filterProperty.habitation.features.exposure
enum<string>[]
Available options:
EXPOSURE_UNKNOWN, EXPOSURE_NORTH, EXPOSURE_NORTH_EAST, EXPOSURE_EAST, EXPOSURE_SOUTH_EAST, EXPOSURE_SOUTH, EXPOSURE_SOUTH_WEST, EXPOSURE_WEST, EXPOSURE_NORTH_WEST alerts.alert.filterProperty.habitation.features.furniture
enum<string>[]
Available options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED alerts.alert.filterProperty.habitation.features.constructionMaterials
enum<string>[]
Available options:
MATERIAL_UNKNOWN, MATERIAL_WOODEN, MATERIAL_STEEL, MATERIAL_STONE, MATERIAL_PVC, MATERIAL_CONCRETE, MATERIAL_ALUMINIUM, MATERIAL_HALF_TIMBERED, MATERIAL_MARBLE, MATERIAL_BRICK, MATERIAL_CINDER_BLOCK, MATERIAL_PREFABRICATED, MATERIAL_ADOBE, MATERIAL_COATING alerts.alert.filterProperty.habitation.features.viewOns
enum<string>[]
Available options:
VIEW_ON_UNKNOWN, VIEW_ON_SEA, VIEW_ON_HILLS, VIEW_ON_RIVERS, VIEW_ON_CITY, VIEW_ON_PARK, VIEW_ON_VERDURE, VIEW_ON_STREET, VIEW_ON_COURTYARD, VIEW_ON_COUNTRYSIDE, VIEW_ON_MOUNTAIN, VIEW_ON_GARDEN_TERRACE, VIEW_ON_LAKE, VIEW_ON_SKI_SLOPES, VIEW_ON_PORT, VIEW_ON_POI, VIEW_ON_SKY, VIEW_ON_WATER, VIEW_ON_VINEYARD, VIEW_ON_ROOF alerts.alert.filterProperty.habitation.features.glazingTypes
enum<string>[]
Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE alerts.alert.filterProperty.habitation.features.hasThroughExposure
boolean
alerts.alert.filterProperty.habitation.characteristics
object
alerts.alert.filterProperty.habitation.characteristics.hasLift
boolean
alerts.alert.filterProperty.habitation.characteristics.hasCellar
boolean
alerts.alert.filterProperty.habitation.characteristics.hasBalcony
boolean
alerts.alert.filterProperty.habitation.characteristics.hasTerrace
boolean
alerts.alert.filterProperty.habitation.characteristics.hasGarden
boolean
alerts.alert.filterProperty.habitation.characteristics.hasFireplace
boolean
alerts.alert.filterProperty.habitation.characteristics.hasGrenier
boolean
alerts.alert.filterProperty.habitation.characteristics.hasPool
boolean
alerts.alert.filterProperty.habitation.characteristics.hasParking
boolean
alerts.alert.filterProperty.habitation.characteristics.hasGarage
boolean
alerts.alert.filterProperty.habitation.characteristics.hasLand
boolean
alerts.alert.filterProperty.habitation.characteristics.hasConcierge
boolean
alerts.alert.filterProperty.habitation.characteristics.hasDigicode
boolean
alerts.alert.filterProperty.habitation.characteristics.hasInterphone
boolean
alerts.alert.filterProperty.habitation.characteristics.hasAlarm
boolean
alerts.alert.filterProperty.habitation.characteristics.hasVisAVis
boolean
alerts.alert.filterProperty.habitation.characteristics.isPeaceful
boolean
alerts.alert.filterProperty.habitation.characteristics.hasMezzanine
boolean
alerts.alert.filterProperty.habitation.characteristics.hasJacuzzi
boolean
alerts.alert.filterProperty.habitation.climate
object
alerts.alert.filterProperty.habitation.climate.epcEnergy
enum<string>[]
Available options:
ENERGY_CLASSIFICATION_UNKNOWN, ENERGY_CLASSIFICATION_G, ENERGY_CLASSIFICATION_F, ENERGY_CLASSIFICATION_E, ENERGY_CLASSIFICATION_D, ENERGY_CLASSIFICATION_C, ENERGY_CLASSIFICATION_B, ENERGY_CLASSIFICATION_A, ENERGY_CLASSIFICATION_NC alerts.alert.filterProperty.habitation.climate.epcClimate
enum<string>[]
Available options:
GREENHOUSE_CLASSIFICATION_UNKNOWN, GREENHOUSE_CLASSIFICATION_G, GREENHOUSE_CLASSIFICATION_F, GREENHOUSE_CLASSIFICATION_E, GREENHOUSE_CLASSIFICATION_D, GREENHOUSE_CLASSIFICATION_C, GREENHOUSE_CLASSIFICATION_B, GREENHOUSE_CLASSIFICATION_A, GREENHOUSE_CLASSIFICATION_NC alerts.alert.filterProperty.habitation.climate.epcEnergyScore
object
alerts.alert.filterProperty.habitation.climate.epcEnergyScore.min
integer
alerts.alert.filterProperty.habitation.climate.epcEnergyScore.max
integer
alerts.alert.filterProperty.habitation.climate.epcClimateScore
object
alerts.alert.filterProperty.habitation.climate.epcClimateScore.min
integer
alerts.alert.filterProperty.habitation.climate.epcClimateScore.max
integer
alerts.alert.filterProperty.habitation.climate.epcClimateDate
object
alerts.alert.filterProperty.habitation.climate.epcClimateDate.min
string
alerts.alert.filterProperty.habitation.climate.epcClimateDate.max
string
alerts.alert.filterProperty.habitation.climate.epcEnergyDate
object
alerts.alert.filterProperty.habitation.climate.epcEnergyDate.min
string
alerts.alert.filterProperty.habitation.climate.epcEnergyDate.max
string
alerts.alert.filterProperty.habitation.propertyCondition
object[]
alerts.alert.filterProperty.habitation.propertyCondition.interiorCondition
enum<string>
default: INTERIOR_CONDITION_UNKNOWNAvailable options:
INTERIOR_CONDITION_UNKNOWN, INTERIOR_CONDITION_EXCELLENT, INTERIOR_CONDITION_TO_REFRESH, INTERIOR_CONDITION_SMALL_WORKS_TO_BE_PLANNED, INTERIOR_CONDITION_MAJOR_WORKS_TO_BE_PALLNED, INTERIOR_CONDITION_BRAND_NEW, INTERIOR_CONDITION_GOOD_CONDITION, INTERIOR_CONDITION_TO_BE_RENOVATED alerts.alert.filterProperty.habitation.propertyCondition.constructionYear
integer
alerts.alert.filterProperty.habitation.propertyCondition.generalConditions
enum<string>[]
Available options:
GENERAL_CONDITION_UNKNOWN, GENERAL_CONDITION_TO_BE_RENOVATED, GENERAL_CONDITION_BRAND_NEW, GENERAL_CONDITION_RENOVATED, GENERAL_CONDITION_TO_BE_REFRESHED, GENERAL_CONDITION_GOOD, GENERAL_CONDITION_EXCELLENT, GENERAL_CONDITION_DECREPIT, GENERAL_CONDITION_TO_BE_BUILT alerts.alert.filterProperty.habitation.propertyCondition.renovationYear
integer
alerts.alert.filterProperty.habitation.surface
object
alerts.alert.filterProperty.habitation.surface.total
object
alerts.alert.filterProperty.habitation.surface.total.min
integer
alerts.alert.filterProperty.habitation.surface.total.max
integer
alerts.alert.filterProperty.habitation.surface.livingSpace
object
alerts.alert.filterProperty.habitation.surface.livingSpace.min
integer
alerts.alert.filterProperty.habitation.surface.livingSpace.max
integer
alerts.alert.filterProperty.habitation.surface.floorSpace
object
alerts.alert.filterProperty.habitation.surface.floorSpace.min
integer
alerts.alert.filterProperty.habitation.surface.floorSpace.max
integer
alerts.alert.filterProperty.habitation.surface.livingroom
object
alerts.alert.filterProperty.habitation.surface.livingroom.min
integer
alerts.alert.filterProperty.habitation.surface.livingroom.max
integer
alerts.alert.filterProperty.habitation.surface.kitchen
object
alerts.alert.filterProperty.habitation.surface.kitchen.min
integer
alerts.alert.filterProperty.habitation.surface.kitchen.max
integer
alerts.alert.filterProperty.habitation.surface.groundFloor
object
alerts.alert.filterProperty.habitation.surface.groundFloor.min
integer
alerts.alert.filterProperty.habitation.surface.groundFloor.max
integer
alerts.alert.filterProperty.habitation.surface.balconies
object
alerts.alert.filterProperty.habitation.surface.balconies.min
integer
alerts.alert.filterProperty.habitation.surface.balconies.max
integer
alerts.alert.filterProperty.habitation.surface.terraces
object
alerts.alert.filterProperty.habitation.surface.terraces.min
integer
alerts.alert.filterProperty.habitation.surface.terraces.max
integer
alerts.alert.filterProperty.habitation.surface.gardens
object
alerts.alert.filterProperty.habitation.surface.gardens.min
integer
alerts.alert.filterProperty.habitation.surface.gardens.max
integer
alerts.alert.filterProperty.parking
object
alerts.alert.filterProperty.parking.type
enum<string>[]
Available options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING alerts.alert.filterProperty.parking.count
object
alerts.alert.filterProperty.parking.count.min
integer
alerts.alert.filterProperty.parking.count.max
integer
alerts.alert.filterProperty.parking.numberOfCars
object
alerts.alert.filterProperty.parking.numberOfCars.min
integer
alerts.alert.filterProperty.parking.numberOfCars.max
integer
alerts.alert.filterProperty.parking.surface
object
alerts.alert.filterProperty.parking.surface.min
integer
alerts.alert.filterProperty.parking.surface.max
integer
alerts.alert.filterProperty.land
object
alerts.alert.filterProperty.land.type
enum<string>[]
Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST alerts.alert.filterProperty.land.haveBuildingPermit
boolean
alerts.alert.filterProperty.land.canConstruct
boolean
alerts.alert.filterProperty.land.surfaceConstructable
object
alerts.alert.filterProperty.land.surfaceConstructable.min
integer
alerts.alert.filterProperty.land.surfaceConstructable.max
integer
alerts.alert.filterProperty.land.surface
object
alerts.alert.filterProperty.land.surface.min
integer
alerts.alert.filterProperty.land.surface.max
integer
alerts.alert.filterProperty.land.isServiced
boolean
alerts.alert.filterProperty.land.haveWater
boolean
alerts.alert.filterProperty.land.haveElectricity
boolean
alerts.alert.filterProperty.land.haveTelecom
boolean
alerts.alert.filterProperty.location
object[]
alerts.alert.filterProperty.location.address
object
alerts.alert.filterProperty.location.address.number
string
alerts.alert.filterProperty.location.address.streetName
string
alerts.alert.filterProperty.location.postalCode
string
alerts.alert.filterProperty.location.inseeCode
string
alerts.alert.filterProperty.location.irisCode
string
alerts.alert.filterProperty.location.department
string
alerts.alert.filterProperty.location.city
string
alerts.alert.filterProperty.location.locationCoordinate
object
alerts.alert.filterProperty.location.locationCoordinate.location
object
alerts.alert.filterProperty.location.locationCoordinate.location.preregisteredShape
object
Shape which has already been stored inside fluximmo services. This is particularly useful for when you have a pre-defined list of shapes and you want to reference the list using a logical name (for example Ile-de-France) rather than having to provide coordinates each time.
alerts.alert.filterProperty.location.locationCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alerts.alert.filterProperty.location.locationCoordinate.location.preregisteredShape.id
string
alerts.alert.filterProperty.location.locationCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alerts.alert.filterProperty.location.locationCoordinate.location.geoDistance.distanceKm
number
alerts.alert.filterProperty.location.locationCoordinate.location.geoDistance.pin
object
alerts.alert.filterProperty.location.locationCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoBoundingBox
object
Use a geo_bounding_box filter to match geo_point values that intersect a bounding box. To define the box, provide geopoint values for two opposite corners.
alerts.alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft
object
alerts.alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight
object
alerts.alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoShape
object
Filter documents indexed using. The behaviour of the GeoShape query depends on the type and relation defined. This have the same specs as the GeoJson RFC 7946 (read more here: https://geojson.org/)
alerts.alert.filterProperty.location.locationCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alerts.alert.filterProperty.location.locationCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alerts.alert.filterProperty.location.locationCoordinate.location.geoShape.coordinates
object[]
alerts.alert.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alerts.alert.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance.distanceKm
number
alerts.alert.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance.inseeCode
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index1
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index2
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index3
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index4
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index5
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index6
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index7
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index8
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index9
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index10
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index11
string
alerts.alert.filterProperty.location.locationCoordinate.h3Indices.h3Index12
string
alerts.alert.filterProperty.location.cityCoordinate
object
alerts.alert.filterProperty.location.cityCoordinate.location
object
alerts.alert.filterProperty.location.cityCoordinate.location.preregisteredShape
object
Shape which has already been stored inside fluximmo services. This is particularly useful for when you have a pre-defined list of shapes and you want to reference the list using a logical name (for example Ile-de-France) rather than having to provide coordinates each time.
alerts.alert.filterProperty.location.cityCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alerts.alert.filterProperty.location.cityCoordinate.location.preregisteredShape.id
string
alerts.alert.filterProperty.location.cityCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alerts.alert.filterProperty.location.cityCoordinate.location.geoDistance.distanceKm
number
alerts.alert.filterProperty.location.cityCoordinate.location.geoDistance.pin
object
alerts.alert.filterProperty.location.cityCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoBoundingBox
object
Use a geo_bounding_box filter to match geo_point values that intersect a bounding box. To define the box, provide geopoint values for two opposite corners.
alerts.alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft
object
alerts.alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight
object
alerts.alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoShape
object
Filter documents indexed using. The behaviour of the GeoShape query depends on the type and relation defined. This have the same specs as the GeoJson RFC 7946 (read more here: https://geojson.org/)
alerts.alert.filterProperty.location.cityCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alerts.alert.filterProperty.location.cityCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alerts.alert.filterProperty.location.cityCoordinate.location.geoShape.coordinates
object[]
alerts.alert.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alerts.alert.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance.distanceKm
number
alerts.alert.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance.inseeCode
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index1
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index2
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index3
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index4
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index5
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index6
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index7
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index8
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index9
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index10
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index11
string
alerts.alert.filterProperty.location.cityCoordinate.h3Indices.h3Index12
string
alerts.alert.filterProperty.history
object[]
alerts.alert.filterProperty.history.seenAt
object
alerts.alert.filterProperty.history.seenAt.min
string
alerts.alert.filterProperty.history.seenAt.max
string
alerts.alert.filterProperty.history.price
object
alerts.alert.filterProperty.history.price.min
integer
alerts.alert.filterProperty.history.price.max
integer
alerts.alert.filterProperty.history.pricePerArea
object
alerts.alert.filterProperty.history.pricePerArea.min
integer
alerts.alert.filterProperty.history.pricePerArea.max
integer
alerts.alert.filterProperty.history.nbDaysPublished
object
alerts.alert.filterProperty.history.nbDaysPublished.min
integer
alerts.alert.filterProperty.history.nbDaysPublished.max
integer
alerts.alert.filterProperty.history.source
object
alerts.alert.filterProperty.history.source.website
string
alerts.alert.filterProperty.history.source.url
string
alerts.alert.filterProperty.history.source.flxId
string
alerts.alert.filterProperty.adverts
object[]
alerts.alert.filterProperty.adverts.flxId
string[]
alerts.alert.filterProperty.adverts.isPro
boolean
alerts.alert.filterProperty.adverts.seller
object[]
alerts.alert.filterProperty.adverts.seller.type
enum<string>
default: SELLER_TYPE_UNKNOWNAvailable options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK alerts.alert.filterProperty.adverts.seller.flxId
string
alerts.alert.filterProperty.adverts.seller.name
string
alerts.alert.filterProperty.adverts.seller.siren
string
alerts.alert.filterProperty.adverts.contactInCharge
object
alerts.alert.filterProperty.adverts.contactInCharge.firstName
string
alerts.alert.filterProperty.adverts.contactInCharge.lastName
string
alerts.alert.filterProperty.adverts.contactInCharge.phoneNumber
string
alerts.alert.filterProperty.adverts.contactInCharge.email
string
alerts.alert.filterProperty.adverts.contactInCharge.pseudonym
string
alerts.alert.filterProperty.adverts.source
object
alerts.alert.filterProperty.adverts.source.website
string
alerts.alert.filterProperty.adverts.source.url
string
alerts.alert.filterProperty.adverts.source.flxId
string
alerts.alert.filterProperty.adverts.title
string[]
alerts.alert.filterProperty.adverts.description
string[]
alerts.alert.filterProperty.adverts.isOnline
boolean
alerts.alert.filterProperty.adverts.firstSeenAt
object
alerts.alert.filterProperty.adverts.firstSeenAt.min
string
alerts.alert.filterProperty.adverts.firstSeenAt.max
string
alerts.alert.filterProperty.adverts.lastUpdatedAt
object
alerts.alert.filterProperty.adverts.lastUpdatedAt.min
string
alerts.alert.filterProperty.adverts.lastUpdatedAt.max
string
alerts.alert.filterProperty.adverts.firstPublishedAt
object
alerts.alert.filterProperty.adverts.firstPublishedAt.min
string
alerts.alert.filterProperty.adverts.firstPublishedAt.max
string
alerts.alert.filterProperty.adverts.lastSeenAt
object
alerts.alert.filterProperty.adverts.lastSeenAt.min
string
alerts.alert.filterProperty.adverts.lastSeenAt.max
string
alerts.alert.filterProperty.adverts.price
object
alerts.alert.filterProperty.adverts.price.latest
object
alerts.alert.filterProperty.adverts.price.latest.value
object
alerts.alert.filterProperty.adverts.price.latest.value.min
integer
alerts.alert.filterProperty.adverts.price.latest.value.max
integer
alerts.alert.filterProperty.adverts.price.latest.valuePerArea
object
alerts.alert.filterProperty.adverts.price.latest.valuePerArea.min
integer
alerts.alert.filterProperty.adverts.price.latest.valuePerArea.max
integer
alerts.alert.filterProperty.adverts.price.latest.source
object
alerts.alert.filterProperty.adverts.price.latest.source.website
string
alerts.alert.filterProperty.adverts.price.latest.source.url
string
alerts.alert.filterProperty.adverts.price.latest.source.flxId
string
alerts.alert.filterProperty.adverts.price.lowest
object
alerts.alert.filterProperty.adverts.price.lowest.value
object
alerts.alert.filterProperty.adverts.price.lowest.value.min
integer
alerts.alert.filterProperty.adverts.price.lowest.value.max
integer
alerts.alert.filterProperty.adverts.price.lowest.valuePerArea
object
alerts.alert.filterProperty.adverts.price.lowest.valuePerArea.min
integer
alerts.alert.filterProperty.adverts.price.lowest.valuePerArea.max
integer
alerts.alert.filterProperty.adverts.price.lowest.source
object
alerts.alert.filterProperty.adverts.price.lowest.source.website
string
alerts.alert.filterProperty.adverts.price.lowest.source.url
string
alerts.alert.filterProperty.adverts.price.lowest.source.flxId
string
alerts.alert.filterProperty.adverts.price.highest
object
alerts.alert.filterProperty.adverts.price.highest.value
object
alerts.alert.filterProperty.adverts.price.highest.value.min
integer
alerts.alert.filterProperty.adverts.price.highest.value.max
integer
alerts.alert.filterProperty.adverts.price.highest.valuePerArea
object
alerts.alert.filterProperty.adverts.price.highest.valuePerArea.min
integer
alerts.alert.filterProperty.adverts.price.highest.valuePerArea.max
integer
alerts.alert.filterProperty.adverts.price.highest.source
object
alerts.alert.filterProperty.adverts.price.highest.source.website
string
alerts.alert.filterProperty.adverts.price.highest.source.url
string
alerts.alert.filterProperty.adverts.price.highest.source.flxId
string
alerts.alert.filterProperty.adverts.price.initial
object
alerts.alert.filterProperty.adverts.price.initial.value
object
alerts.alert.filterProperty.adverts.price.initial.value.min
integer
alerts.alert.filterProperty.adverts.price.initial.value.max
integer
alerts.alert.filterProperty.adverts.price.initial.valuePerArea
object
alerts.alert.filterProperty.adverts.price.initial.valuePerArea.min
integer
alerts.alert.filterProperty.adverts.price.initial.valuePerArea.max
integer
alerts.alert.filterProperty.adverts.price.initial.source
object
alerts.alert.filterProperty.adverts.price.initial.source.website
string
alerts.alert.filterProperty.adverts.price.initial.source.url
string
alerts.alert.filterProperty.adverts.price.initial.source.flxId
string
alerts.alert.filterProperty.adverts.price.warrantyDeposit
object
alerts.alert.filterProperty.adverts.price.warrantyDeposit.min
integer
alerts.alert.filterProperty.adverts.price.warrantyDeposit.max
integer
alerts.alert.filterProperty.adverts.price.charges
object
alerts.alert.filterProperty.adverts.price.charges.yearlyRentalFees
number
alerts.alert.filterProperty.adverts.price.charges.yearlyCondoniumFees
number
alerts.alert.filterProperty.adverts.price.charges.yearlyHeatingFees
number
alerts.alert.filterProperty.adverts.price.charges.yearlyElectricityFees
number
alerts.alert.filterProperty.adverts.price.charges.yearlyHousingTax
number
alerts.alert.filterProperty.adverts.price.charges.yearlyLivingTax
number
alerts.alert.filterProperty.adverts.price.charges.monthlyRentSupplement
number
alerts.alert.filterProperty.adverts.price.isAuction
boolean
alerts.alert.filterProperty.adverts.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL alerts.alert.filterProperty.adverts.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD alerts.alert.filterProperty.adverts.price.variation
object[]
alerts.alert.filterProperty.adverts.price.variation.sincePublished
object
alerts.alert.filterProperty.adverts.price.variation.sincePublished.min
number
alerts.alert.filterProperty.adverts.price.variation.sincePublished.max
number
alerts.alert.filterProperty.adverts.price.variation.sinceLastModified
object
alerts.alert.filterProperty.adverts.price.variation.sinceLastModified.min
number
alerts.alert.filterProperty.adverts.price.variation.sinceLastModified.max
number
alerts.alert.filterProperty.adverts.location
object
alerts.alert.filterProperty.adverts.location.preregisteredShape
object
Shape which has already been stored inside fluximmo services. This is particularly useful for when you have a pre-defined list of shapes and you want to reference the list using a logical name (for example Ile-de-France) rather than having to provide coordinates each time.
alerts.alert.filterProperty.adverts.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alerts.alert.filterProperty.adverts.location.preregisteredShape.id
string
alerts.alert.filterProperty.adverts.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alerts.alert.filterProperty.adverts.location.geoDistance.distanceKm
number
alerts.alert.filterProperty.adverts.location.geoDistance.pin
object
alerts.alert.filterProperty.adverts.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.adverts.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.adverts.location.geoBoundingBox
object
Use a geo_bounding_box filter to match geo_point values that intersect a bounding box. To define the box, provide geopoint values for two opposite corners.
alerts.alert.filterProperty.adverts.location.geoBoundingBox.topLeft
object
alerts.alert.filterProperty.adverts.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.adverts.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.adverts.location.geoBoundingBox.bottomRight
object
alerts.alert.filterProperty.adverts.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.adverts.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.adverts.location.geoShape
object
Filter documents indexed using. The behaviour of the GeoShape query depends on the type and relation defined. This have the same specs as the GeoJson RFC 7946 (read more here: https://geojson.org/)
alerts.alert.filterProperty.adverts.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alerts.alert.filterProperty.adverts.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alerts.alert.filterProperty.adverts.location.geoShape.coordinates
object[]
alerts.alert.filterProperty.adverts.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alerts.alert.filterProperty.adverts.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alerts.alert.filterProperty.adverts.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alerts.alert.filterProperty.adverts.location.geoInseeCodeDistance.distanceKm
number
alerts.alert.filterProperty.adverts.location.geoInseeCodeDistance.inseeCode
string
alerts.alert.filterProperty.adverts.hasAnomaly
boolean
alerts.alert.filterProperty.adverts.anomalies
enum<string>[]
Available options:
UNKNOWN_ANOMALY, NO_EXACT_LOCATION_ANOMALY, NO_PARKING_COUNT_ANOMALY, NO_DESCRIPTION_ANOMALY, NO_MEDIAS_ANOMALY, NO_PICTURE_ANOMALY, TOO_SHORT_DESCRIPTION_ANOMALY, TOO_SHORT_TITLE_ANOMALY, LOW_PRICE_ANOMALY, HIGH_PRICE_ANOMALY, INCOHERENT_LOCATION_ANOMALY, INCOHERENT_LAND_VALUES_ANOMALY, INCOHERENT_HABITATION_VALUES_ANOMALY, TOO_SMALL_ROOM_ANOMALY, SURFACE_IS_NONE, ROOM_COUNT_IS_NONE, BEDROOM_COUNT_IS_NONE, PRICE_INCOHERENT, TITLE_TOO_SHORT, DESCRIPTION_TOO_SHORT, PRICE_IS_NONE, POSTAL_CODE_IS_NONE, INSEE_CODE_IS_NONE, CITY_IS_NONE, OFFER_TYPE_IS_NONE, TYPE_IS_NONE alerts.alert.filterProperty.adverts.isExclusive
boolean
alerts.alert.filterProperty.isCityCenter
boolean
alerts.alert.filterProperty.hasAnomaly
boolean
alerts.alert.filterProperty.estimatedPrice
object
alerts.alert.filterProperty.estimatedPrice.value
object
alerts.alert.filterProperty.estimatedPrice.value.min
integer
alerts.alert.filterProperty.estimatedPrice.value.max
integer
alerts.alert.filterProperty.estimatedPrice.valuePerArea
object
alerts.alert.filterProperty.estimatedPrice.valuePerArea.min
integer
alerts.alert.filterProperty.estimatedPrice.valuePerArea.max
integer
alerts.alert.filterProperty.estimatedPrice.source
object
alerts.alert.filterProperty.estimatedPrice.source.website
string
alerts.alert.filterProperty.estimatedPrice.source.url
string
alerts.alert.filterProperty.estimatedPrice.source.flxId
string
alerts.alert.filterProperty.imagesLength
object
alerts.alert.filterProperty.imagesLength.min
integer
alerts.alert.filterProperty.imagesLength.max
integer
alerts.alert.filterProperty.advertsLength
object
alerts.alert.filterProperty.advertsLength.min
integer
alerts.alert.filterProperty.advertsLength.max
integer
alerts.alert.filterProperty.historyLength
object
alerts.alert.filterProperty.historyLength.min
integer
alerts.alert.filterProperty.historyLength.max
integer
alerts.alert.filterProperty.anomalies
enum<string>[]
Available options:
UNKNOWN_ANOMALY, NO_EXACT_LOCATION_ANOMALY, NO_PARKING_COUNT_ANOMALY, NO_DESCRIPTION_ANOMALY, NO_MEDIAS_ANOMALY, NO_PICTURE_ANOMALY, TOO_SHORT_DESCRIPTION_ANOMALY, TOO_SHORT_TITLE_ANOMALY, LOW_PRICE_ANOMALY, HIGH_PRICE_ANOMALY, INCOHERENT_LOCATION_ANOMALY, INCOHERENT_LAND_VALUES_ANOMALY, INCOHERENT_HABITATION_VALUES_ANOMALY, TOO_SMALL_ROOM_ANOMALY, SURFACE_IS_NONE, ROOM_COUNT_IS_NONE, BEDROOM_COUNT_IS_NONE, PRICE_INCOHERENT, TITLE_TOO_SHORT, DESCRIPTION_TOO_SHORT, PRICE_IS_NONE, POSTAL_CODE_IS_NONE, INSEE_CODE_IS_NONE, CITY_IS_NONE, OFFER_TYPE_IS_NONE, TYPE_IS_NONE alerts.isActive
boolean
alerts.match
enum<string>[]
Available options:
ALERT_MATCH_UNKNOWN, ALERT_MATCH_PRICE, ALERT_MATCH_CREATED, ALERT_MATCH_OFFLINE, ALERT_MATCH_MERGED alerts.context
object
alerts.context.metadata
object
Response
200 - application/json
results
object[]
results.success
object
results.success.kind
string
results.success.internalDelay
integer
results.success.created
string
results.success.updated
string
results.success.deleted
string
results.success.noop
string
results.failed
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
results.failed.code
integer
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
results.failed.message
string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
results.failed.details
object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
results.failed.details.@type
string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: README.md _snippets api-ai-reference api-analytics-reference api-elasticimmo-reference api-geography-reference api-maps-reference api-search-alert-reference authentification.mdx doc favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_elasticimmo.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-elasticimmo.json swagger-geography.json swagger-maps.json tmp.txt If no scheme is provided, https is assumed. README.md _snippets api-ai-reference api-analytics-reference api-elasticimmo-reference api-geography-reference api-maps-reference api-search-alert-reference authentification.mdx doc favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_elasticimmo.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-elasticimmo.json swagger-geography.json swagger-maps.json tmp.txt An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. README.md _snippets api-ai-reference api-analytics-reference api-elasticimmo-reference api-geography-reference api-maps-reference api-search-alert-reference authentification.mdx doc favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_elasticimmo.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-elasticimmo.json swagger-geography.json swagger-maps.json tmp.txt Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
Was this page helpful?