← Home
Get Property Insights
Get Property Insights
Gather in-depth insights to help you improve the performance of your inventory.
🔐 Bearer Token: Provide your bearer token in the Authorization header when making requests to protected resources.
Query Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| user | string | Optional | ||
| portal | string | Optional | Filter by portal : bayut or dubizzle | bayut |
| property_id | string | Optional | search insights by single property eg : 8972466 | 8972466 |
| purpose | string | Optional | purpose of the property (e.g. sale / rent). | sale |
| is_incomplete | boolean | Optional | This filter can be used to filter incomplete properties when the value 1 is provided. | |
| status[] | array[string] | Optional | ||
| location_id | string | Optional | Should be only loc level 3 location id | |
| is_low_performing | boolean | Optional | ||
| days | string | Optional | This field is used to identify low-performing properties over a specified range of days and can also be used for sorting. | |
| sort_by | string | Optional | this field help to sort on newest,high_impressions,low_impressions,high_clicks,low_clicks over the last 30 days by default.The period can be adjusted using the days field. | newest |
| per_page | string | Optional | Number of items per page (optional, max 50) | |
| page | string | Optional | Page number for pagination. Default: 1. | |
| Accept | string | Optional | application/json | |
| Authorization | string | Optional | Bearer {{access_token}} |
Response Schema
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| data | array[object] | Optional | Property Object | |
| property | object | Optional | Property Object | |
| performance | object | Optional | Performance of property | |
| market_comparison_with_similar_properties | object | Optional | ||
| insights | object | Optional | Property Insight | |
| links | object | Optional | ||
| first | string | Optional | ||
| last | string | Optional | ||
| prev | null | Optional | ||
| next | string | Optional | ||
| meta | object | Optional | ||
| current_page | integer | Optional | ||
| from | integer | Optional | ||
| last_page | integer | Optional | ||
| path | string | Optional | ||
| to | integer | Optional | ||
| total | integer | Optional |
Responses
200✅
Code Examples
curl --location --globoff 'https://api.bayut.com/v1/users//stats/property-insights?portal=bayut&property_id=&purpose=&is_incomplete=&status[]=&location_id=undefined&is_low_performing=&days=&sort_by=undefined&per_page=&page=' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'{
"data": [
{
"property": {
"id": 12312312,
"reference": "test123",
"url": "https://bayut.com/property/details-7664516.html",
"image": "https://assets.bayut.com/listing-images/ln1ln1B19kDPcMbo1CfWXKVVF7wnZ3FkoO6QJ7Wq",
"price": 5690,
"beds": 0,
"baths": 1,
"area_sqft": 446,
"current_product": "Basic",
"agency": {
"id": 10292,
"name": "Test Holiday Homes"
},
"agent": {
"id": 1001426,
"name": "Joe Doe",
"profile_image": "https://assets.bayut.com/agents/erwrwqe"
},
"quality": {
"images": {
"total": 10,
"minimum_required": 6
},
"description_length": 1961,
"has_floorplan": false,
"agent_profile_complete": true,
"has_video": false,
"is_truchecked": false,
"has_similar_property": true,
"is_completed": true
}
},
"performance": {
"impressions": {
"7_days": 1231,
"15_days": 3434,
"30_days": 5023
},
"clicks": {
"7_days": 1231,
"15_days": 3434,
"30_days": 5023
},
"click_through_rate": {
"7_days": 1231,
"15_days": 3434,
"30_days": 5023
},
"leads": {
"7_days": 1231,
"15_days": 3434,
"30_days": 5023
}
},
"market_comparison_with_similar_properties": {
"average_price": 4946.78,
"impressions": {
"7_days": 1077,
"15_days": 2252,
"30_days": 4466
},
"clicks": {
"7_days": 47,
"15_days": 84,
"30_days": 136
},
"click_through_rate": {
"7_days": 3,
"15_days": 3,
"30_days": 2
},
"leads": {
"7_days": 5,
"15_days": 10,
"30_days": 16
}
},
"insights": {
"is_low_performing": {
"7_days": true,
"15_days": true,
"30_days": true
}
}
}
],
"links": {
"first": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=1&days=30",
"last": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=1309717&days=30",
"prev": null,
"next": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=2&days=30"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1309717,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=1&days=30",
"label": "1",
"active": true
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=2&days=30",
"label": "2",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=3&days=30",
"label": "3",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=4&days=30",
"label": "4",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=5&days=30",
"label": "5",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=6&days=30",
"label": "6",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=7&days=30",
"label": "7",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=8&days=30",
"label": "8",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=9&days=30",
"label": "9",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=10&days=30",
"label": "10",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=1309716&days=30",
"label": "1309716",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=1309717&days=30",
"label": "1309717",
"active": false
},
{
"url": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights?portal=bayut&per_page=1&page=2&days=30",
"label": "Next »",
"active": false
}
],
"path": "http://127.0.0.1:8000/v1/users/2388402/stats/property-insights",
"per_page": 1,
"to": 1,
"total": 1309717
}
}