This web service is used to obtain the number of hits for a property.
| Resource information | |
|---|---|
| Authentication | Required (JWT) |
| Parameters | Required |
| HTTP Method | GET |
| Response | JSON |
Resource URL
https://property-api.mapaprop.com/property/get/hits
Authentication
A JWT token is required in the Authorization: Bearer {access_token} header. The customerId is derived from the token: it is NOT sent as a parameter.
Parameters request.
| Key | Type | Required | Description |
|---|---|---|---|
| propertyId | String | yes | the property id identifier |
| brandId | String | yes | brand or system sending data |
| originId | String | yes | originating portal sending the data |
| originCountry | String | yes | country code to store customer's local time |
| days | String | yes | number of days from current date |
Parameters conditions
- The
daysparameter only accepts these values: 1, 7, 14, 30, 90.
Example curl
curl --location 'https://property-api.mapaprop.com/property/get/hits?propertyId=213251&days=14&originCountry=ar&originId=PatagonProp&brandId=mapaprop' \
--header 'Authorization: Bearer {access_token}'
Sample code
GET https://property-api.mapaprop.com/property/get/hits Host: property-api.mapaprop.com Content-Type: application/json Authorization: Bearer {access_token} Parameters: propertyId=213251(Number) days=14(Number) originCountry=ar(String) originId=PatagonProp(String) brandId=mapaprop(String)
Response
Returns a JSON object with the property hit summary for the requested origin and day range.
| Field | Type | Description |
|---|---|---|
days | Number | Number of days in the report (1, 7, 14, 30 or 90). |
hits | Number | Total accumulated hits in the range. |
propertyId | String | Property identifier. |
originUrlHit | String | Property URL on the source portal. |
customerId | Number | Customer identifier (derived from the token). |
brand | String | Brand / system that sent the data. |
originCountry | String | Source country code. |
originId | String | Source portal. |
report | Object | Map of date (YYYY-MM-DD) → number of hits for that day. |
Sample code
Sample response for the get hits
{ "days": 14, "hits": 7, "propertyId": "213251", "originUrlHit": "https://www.patagonprop.com/ar/propiedad/alquiler-de-departamento-en-caballito-capital-federal-444-191022/5ebebe55a9b6c47f0702173b9a8168cf", "customerId": "444", "brand": "mapaprop", "originCountry": "ar", "originId": "PatagonProp", "report": { "2023-11-07": 0, "2023-11-06": 0, "2023-11-05": 0, "2023-11-04": 1, "2023-11-03": 0, "2023-11-02": 0, "2023-11-01": 0, "2023-10-31": 1, "2023-10-30": 1, "2023-10-29": 1, "2023-10-28": 1, "2023-10-27": 0, "2023-10-26": 2, "2023-10-25": 0 }}
Error Example (status 400 — invalid days value)
Date not available or parameter with error.