Properties General Analytics for search filters

POST

protected

analytics

property

curl --request POST \
  --url https://api.fluximmo.io/v2/protected/analytics/property/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "query": {
    "filterProperty": {
      "land": {
        "surface": {
          "max": 123,
          "min": 123
        }
      },
      "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"
        }
      },
      "price": {
        "latest": {
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          }
        }
      },
      "type": [
        "CLASS_HOUSE"
      ],
      "offer": [],
      "habitation": {
        "bedroomCount": {
          "max": 123,
          "min": 123
        },
        "roomCount": {
          "max": 123,
          "min": 123
        },
        "characteristics": {
          "hasBalcony": true,
          "hasCellar": true,
          "hasGarage": true,
          "hasLift": true,
          "hasParking": true,
          "hasPool": true,
          "hasTerrace": true
        },
        "climate": {
          "epcClimate": [],
          "epcEnergy": []
        },
        "surface": {
          "total": {
            "max": 123,
            "min": 123
          }
        },
        "features": {
          "furniture": [],
          "propertyFloor": {
            "max": 123,
            "min": 123
          },
          "propertyTotalFloor": {
            "max": 123,
            "min": 123
          }
        },
        "propertyCondition": [
          {
            "constructionYear": 123,
            "generalConditions": []
          }
        ]
      }
    },
    "fullTexts": [
      "<string>"
    ],
    "keywords": [
      "<string>"
    ]
  },
  "studiedData": "PRICE_PER_AREA_ANALYZED_TYPE",
  "type": "SUMMARY_ANALYSIS_TYPE"
}'

{
  "data": {
    "percentilesValues": {
      "percentiles": {
        "1.0": 199.01825941147465,
        "25.0": 873.0233360295258,
        "5.0": 320.3792919192797,
        "50.0": 1749.9910946795994,
        "75.0": 3184.9963201136397,
        "95.0": 11208.899561561651,
        "99.0": 48335.94583529406
      }
    },
    "boxplotValue": {
      "lower": 123,
      "max": 123,
      "min": 123,
      "q1": 123,
      "q2": 123,
      "q3": 123,
      "upper": 123
    },
    "advancedKpiValue": {
      "avg": 123,
      "count": 123,
      "max": 123,
      "min": 123,
      "stdDeviation": 123,
      "stdDeviationBounds": {
        "lower": 123,
        "lowerPopulation": 123,
        "lowerSampling": 123,
        "upper": 123,
        "upperPopulation": 123,
        "upperSampling": 123
      },
      "stdDeviationPopulation": 123,
      "stdDeviationSampling": 123,
      "sum": 123,
      "sumOfSquares": 123,
      "variance": 123,
      "variancePopulation": 123,
      "varianceSampling": 123
    },
    "summaryValue": {
      "avg": 123,
      "count": 123,
      "max": 123,
      "min": 123,
      "sum": 123
    },
    "countValue": 123
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

query

object

required

query.filterProperty

object

required

query.filterProperty.land

object

query.filterProperty.location

object[]

Example:

[]

query.filterProperty.meta

object

query.filterProperty.price

object

query.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

Example:

["CLASS_HOUSE"]

query.filterProperty.offer

object[]

Example:

[]

query.filterProperty.habitation

object

query.filterProperty.habitation.bedroomCount

object

query.filterProperty.habitation.roomCount

object

query.filterProperty.habitation.characteristics

object

query.filterProperty.habitation.climate

object

query.filterProperty.habitation.climate.epcClimate

enum<string>[]

The classification value of the greenhouse gas emission classification - GES

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

Example:

[]

query.filterProperty.habitation.climate.epcEnergy

enum<string>[]

The classification value of the energy classification - DPE

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

Example:

[]

query.filterProperty.habitation.surface

object

query.filterProperty.habitation.features

object

query.filterProperty.habitation.features.furniture

enum<string>[]

Available options:

UNKNOWN_FURNITURE,

UNFURNISHED,

PARTIALLY_FURNISHED,

FULLY_FURNISHED

Example:

[]

query.filterProperty.habitation.features.propertyFloor

object

query.filterProperty.habitation.features.propertyTotalFloor

object

query.filterProperty.habitation.propertyCondition

object[]

query.filterProperty.habitation.propertyCondition.constructionYear

number

query.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

Example:

[]

query.fullTexts

string[]

required

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).

query.keywords

string[]

required

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).

studiedData

enum<string>

required

Available options:

PRICE_ANALYZED_TYPE,

HABITATION_SURFACE_ANALYZED_TYPE,

LAND_SURFACE_ANALYZED_TYPE,

PRICE_PER_AREA_ANALYZED_TYPE

type

enum<string>

required

Available options:

SUMMARY_ANALYSIS_TYPE,

ADVANCED_ANALYSIS_TYPE,

BOX_PLOT_ANALYSIS_TYPE,

PERCENTILES_ANALYSIS_TYPE

Response

200

application/json

data

object

Analytics data for the given context

data.percentilesValues

object

data.percentilesValues.percentiles

object

Example:

{
  "1.0": 199.01825941147465,
  "25.0": 873.0233360295258,
  "5.0": 320.3792919192797,
  "50.0": 1749.9910946795994,
  "75.0": 3184.9963201136397,
  "95.0": 11208.899561561651,
  "99.0": 48335.94583529406
}

data.boxplotValue

object

data.advancedKpiValue

object

data.summaryValue

object

data.countValue

number

Was this page helpful?

Count properties for search filters Prices per area statistics

curl --request POST \
  --url https://api.fluximmo.io/v2/protected/analytics/property/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "query": {
    "filterProperty": {
      "land": {
        "surface": {
          "max": 123,
          "min": 123
        }
      },
      "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"
        }
      },
      "price": {
        "latest": {
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          }
        }
      },
      "type": [
        "CLASS_HOUSE"
      ],
      "offer": [],
      "habitation": {
        "bedroomCount": {
          "max": 123,
          "min": 123
        },
        "roomCount": {
          "max": 123,
          "min": 123
        },
        "characteristics": {
          "hasBalcony": true,
          "hasCellar": true,
          "hasGarage": true,
          "hasLift": true,
          "hasParking": true,
          "hasPool": true,
          "hasTerrace": true
        },
        "climate": {
          "epcClimate": [],
          "epcEnergy": []
        },
        "surface": {
          "total": {
            "max": 123,
            "min": 123
          }
        },
        "features": {
          "furniture": [],
          "propertyFloor": {
            "max": 123,
            "min": 123
          },
          "propertyTotalFloor": {
            "max": 123,
            "min": 123
          }
        },
        "propertyCondition": [
          {
            "constructionYear": 123,
            "generalConditions": []
          }
        ]
      }
    },
    "fullTexts": [
      "<string>"
    ],
    "keywords": [
      "<string>"
    ]
  },
  "studiedData": "PRICE_PER_AREA_ANALYZED_TYPE",
  "type": "SUMMARY_ANALYSIS_TYPE"
}'

{
  "data": {
    "percentilesValues": {
      "percentiles": {
        "1.0": 199.01825941147465,
        "25.0": 873.0233360295258,
        "5.0": 320.3792919192797,
        "50.0": 1749.9910946795994,
        "75.0": 3184.9963201136397,
        "95.0": 11208.899561561651,
        "99.0": 48335.94583529406
      }
    },
    "boxplotValue": {
      "lower": 123,
      "max": 123,
      "min": 123,
      "q1": 123,
      "q2": 123,
      "q3": 123,
      "upper": 123
    },
    "advancedKpiValue": {
      "avg": 123,
      "count": 123,
      "max": 123,
      "min": 123,
      "stdDeviation": 123,
      "stdDeviationBounds": {
        "lower": 123,
        "lowerPopulation": 123,
        "lowerSampling": 123,
        "upper": 123,
        "upperPopulation": 123,
        "upperSampling": 123
      },
      "stdDeviationPopulation": 123,
      "stdDeviationSampling": 123,
      "sum": 123,
      "sumOfSquares": 123,
      "variance": 123,
      "variancePopulation": 123,
      "varianceSampling": 123
    },
    "summaryValue": {
      "avg": 123,
      "count": 123,
      "max": 123,
      "min": 123,
      "sum": 123
    },
    "countValue": 123
  }
}

Properties Analytics

Market Analytics

Authorizations

Body

Response