Record a source observation

What a site saw about where a visit came from. Resolved against the property's attribution rules, then stored with personal and credential-shaped values stripped. The result says which source matched.

POST/api/sites/v1/source-observations

Authorization

websiteToken

AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Header Parameters

X-Resi-Website?string

Website id. Overrides Host resolution for builds running where Host is meaningless. The token must still be scoped to this website.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

property*string

A property slug on this website.

occurred_at?string

Formatdate-time

session_id?string

anonymous_id?string

landing_url?string

Stored with credentials and fragments dropped and only source-identifying query parameters kept.

current_url?string

path?string

referrer?string

query_params?

Only UTM parameters, click ids, the CRM's source field and parameters the property's attribution rules read are stored.

click_ids?

Only gclid, gbraid, wbraid, msclkid, fbclid and ttclid are stored, each capped at 512 characters. Any other key is dropped.

external_source_field?string

external_source_value?string

resi_source_key?string

resi_source_name?string

match_status?string

metadata?

Keys that look personal or credential-shaped are stored as [redacted].

Response Body

`application/json`

curl -X POST "https://example.com/api/sites/v1/source-observations" \  -H "Content-Type: application/json" \  -d '{    "property": "string"  }'

{  "data": {    "id": "string",    "status": "string",    "lead_source_id": 0,    "resi_source_key": "string",    "resi_source_name": "string"  },  "meta": {}}

Record a source observation

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

401application/json

403application/json

404application/json

422application/json

429application/json

Authorization

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`