Audience

Listing and companies stats service

This service exposes statistics for listings and companies and it is accessible by specific listing or company id.

Here’s the list of all available metrics:

MetricMetric parameter value
Listing impressions via search resultsIMPRESSION_SERP
Listing impressions via newsletterIMPRESSION_MAIL_ALERT
Listing views (server)DETAIL_VIEW
Listing views (client)DETAIL_VIEW_CLIENT
Click on phone numberPHONE_CLICK
BookmarkBOOKMARK
Hidden listingBLACKLIST
Leads count for listingLEAD
Visit requests sent to listing publisherVISIT_REQUEST
Mobile pin selections for a listingMAP_PIN_SELECTED
Mobile map carousel views for a listingCAROUSEL_LISTING_CHANGED
Listing position in search pagePOSITION
Price proposal lead count for listingPRICE_PROPOSAL
Shared listing event countSHARE
Listing quality scoreQUALITY_SCORE

Can be used on product immotop.lu at the URL https://audience.immotop.lu.

Authentication

The following HTTP Header must be provided in the request:

Accept: application/json
X-IMMO-SOURCE: {partner identifier} (optional)

HTTP Basic Auth is requested for accessing the API, using the credentials provided.

Endpoints

Listings

GET /stats/ad/listing

Metrics by specific listing

Parameters:

NameMandatoryDescription
listingIdYes, when externalId is missingListing id on Indomio
externalIdYes, when listingId is missingListing id on partner platform
startYesStart date (YYYY-MM-DD)
endNoEnd date (YYYY-MM-DD), if missing the start date will be used. The range between start and date cannot exceed one year.
metricsNoA comma-separated, case-insensitive list of metrics to return in the response. If omitted, all available metrics will be returned.
excludedReferrersNoA comma-separated, case-insensitive list of referrers to exclude from the response.
detailsNo, default falseIf true a detail section will be added in the response, giving extra per-day info.
Response
HTTPS status codes
CodeDescription
200Success
500Server Error
404Not existing/supported listing
403Authorization error
400Invalid request
JSON response

Here’s an example with a success json response

{
   "listingId": 90872134,
   "externalId": "abc123",
   "environment": "immobiliare.it",
   "start": "2021-06-01",
   "end": "2021-06-02",
   "metrics": [
       {
           "name": "DETAIL_VIEW",
           "sum": 10,
           "details": [
               {
                   "value": 5,
                   "date": "2021-06-01"
               },
               {
                   "value": 0,
                   "date": "2021-06-02"
               }
           ]
       },
{
            "name": "POSITION",
            "details": [
                {
                    "date": "2021-06-01",
                    "position": 333,
                    "total": 1258
                },
                {
                    "date": "2021-06-02",
                    "position": 333,
                    "total": 1254
                }
            ]
        },
       {
           "name": "SHARE",
           "sum": 6,
           "details": [
               {
                   "value": 3,
                   "date": "2021-06-01"
               },
               {
                   "value": 3,
                   "date": "2021-06-02"
               }
           ]
       }
   ]
}

Here’s an example with an error json response:

{
   "status": 400,
   "message": "Bad Request",
   "errors": [
       {
           "code": "1008",
           "description": "'start' must not be null"
       }
   ]
}

Companies

GET /stats/ad/company

Metrics by specific company

Parameters
NameMandatoryDescription
companyIdYes, when externalId is missingCompany id on Indomio
externalIdYes, when companyId is missingCompany id on partner platform
startYesStart date (YYYY-MM-DD)
endNoEnd date (YYYY-MM-DD), if missing the start date will be used. Range between start and date cannot exceed one year
metricsNoA comma-separated, case-insensitive list of metrics to return in the response. If omitted, all available metrics will be returned.
excludedReferrersNoA comma-separated, case-insensitive list of referrers to exclude from the response.
detailsNo, default falseIf true a detail section will be added in the response, giving extra per-day info.
Response
HTTPS status codes
CodeDescription
200Success
500Server Error
404Not existing company
403Authorization error
400Invalid request
JSON response

Here’s an example with a success json response

{
   "companyId": 90872134,
   "externalId": "abc123",
   "environment": "immobiliare.it",
   "start": "2021-06-01",
   "end": "2021-06-02",
   "listings": [
       {
           "listingId": 1,
           "metrics": [
               {
                   "sum": 20,
                   "name": "DETAIL_VIEW",
                   "details": [
                       {
                           "value": 10,
                           "date": "2021-06-01"
                       },
                       {
                           "value": 10,
                           "date": "2021-06-02"
                       }
                   ]
               }
           ]
       }
   ]
}

Here’s an example with an error json response:

{
   "status": 400,
   "message": "Bad Request",
   "errors": [
       {
           "code": "1008",
           "description": "'start' must not be null"
       }
   ]
}

Listings (write)

POST /collector/ad/stats

Imports metrics for a specific listing

Request Json Fields:
NameMandatoryDescription
dateYesZoned date-time formatted in ISO 8601
listingUuidYesListing uuid on Indomio
metricKeyYesMetric key
metricValueYesMetric value. Must be greater than 0

Here’s an example:

{
  "date": "2025-06-10T09:00:00Z",
  "listingUuid": "listing-uuid",
  "metricKey": "BLACKLIST",
  "metricValue": 3
}
Response
HTTPS status codes
CodeDescription
200Success
400Invalid request
401Authentication error
403Authorization error
500Server Error
JSON response

In case of a status code other than 200, the response includes a JSON body describing the error. Here's an example:

{
  "code": "1004",
  "message": "Permission error"
}

2026 Indomio.com

English Italiano