Get Customer Proximity Summary

Developing

GET

/api/v1/public/{customerId}/proximity-score

Returns an aggregated proximity summary for one customer over the supplied date range, covering the number of location pings analysed, the average proximity score, the registered home address with its Street View stills, and a plain-language interpretation of the score. Both dates are required, and a range with no pings returns a zero summary rather than a 404.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Path Params

Query Params

Responses

🟢200

application/json

Summary returned for the requested window.

Bodyapplication/json

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/public//proximity-score?from=undefined&to=undefined' \
--header 'X-Api-Key: <api-key>'

Response Example

200 - Example 1

{
    "status": true,
    "message": "Operation successful.",
    "data": {
        "customerId": "string",
        "customerFullName": "string",
        "homeAddress": "string",
        "homeLongitude": 0,
        "homeLatitude": 0,
        "addressImages": [
            {
                "heading": 90,
                "imageUrl": "http://example.com"
            }
        ],
        "totalLogsAnalyzed": 42,
        "averageProximityScore": 91.7,
        "dateRangeFrom": "2019-08-24T14:15:22.123Z",
        "dateRangeTo": "2019-08-24T14:15:22.123Z",
        "scoreInterpretation": "Strong match — the customer is consistently at or near their registered address."
    }
}

Modified at 2026-08-06 11:58:31

Get Wallet Balance

Get Collection Schedules For A Customer