Get related visitors

🚧 Deprecation Notice

This version of the API will soon be deprecated under our API Deprecation Policy. The deprecation period will begin once all proxy and library integrations (both backend and frontend) are released. We will continue to provide full support for 12 months from that effective date. This notice will be updated with the official deprecation date once it is set. The API will be fully removed after the deprecation period ends.

Related visitors API lets you link web visits and in-app browser visits that originated from the same mobile device. It searches the past 6 months of identification events to find the visitor IDs that belong to the same mobile device as the given visitor ID.

⚠️ Please note that this API is not enabled by default and is billable separately. ⚠️

If you would like to use Related visitors API, please contact our support team. To learn more, see Related visitors API reference.

GET /related-visitors

Get Related Visitors

cURL

curl --request GET \
  --url https://api.fpjs.io/related-visitors \
  --header 'Auth-API-Key: <api-key>'

200

200-success-empty-response

{
  "relatedVisitors": []
}

Authorizations

ApiKeyHeaderApiKeyQuery

Auth-API-Key · string · header · required

Query Parameters

visitor_id · string · required

The visitor ID for which you want to find the other visitor IDs that originated from the same mobile device.

Response

200

application/json

OK.

relatedVisitors · object[] · required

Show child attributes