Skip to main content

Referrer Mappings

Referrer Mappings let you assign a specific source, medium, and campaign to traffic that arrives from a known referrer domain. When a visit comes from a domain you have mapped and the URL carries no UTM parameters, SealMetrics applies the UTM values you configured automatically.

This is useful for properly attributing traffic from:

  • Partner sites
  • Affiliates
  • Internal domains
  • Any referrer you want to label with a consistent source/medium
Referrer Mappings vs. UTM Mappings

Referrer Mappings act on the referrer domain of an incoming visit. They are different from UTM Mappings, which rename or group UTM values that are already present in the URL. See How to change UTM parameters for UTM Mappings.

Not yet applied at ingest

The API endpoints work and mappings are stored per account, but the tracking pipeline does not yet read this table when classifying incoming traffic — saved mappings have no effect on attribution today. For traffic that needs to be re-attributed now, use Channel Grouping rules or UTM Mappings instead. See the Referrer Mappings API reference for details.


How It Works

  • When traffic comes from a matched referrer without UTM parameters in the URL, the configured UTM values are applied.
  • Existing UTM parameters in the URL are never overwritten. An explicit utm_source/utm_medium/utm_campaign always wins.
  • When several mappings could match, the one with the highest priority is applied first (priority is a 01000 scale).

How to Set It Up

Configured via the API

Referrer Mappings are currently managed through the Sealmetrics API, not from a dashboard screen. Create, update and inspect mappings with the API calls shown below. See the Referrer Mappings API reference for the complete request/response schema.

Mappings are scoped to an account. Create one with your API key:

curl -X POST "https://my.sealmetrics.com/api/v1/referrer-mappings?account_id=YOUR_ACCOUNT_ID" \
-H "X-API-Key: sm_your_key" \
-H "Content-Type: application/json" \
-d '{
"referrer_pattern": "partner-site.com",
"match_type": "exact",
"utm_source": "partner-site",
"utm_medium": "referral",
"label": "Partner Site Traffic"
}'

All management is done through the API:

  • List mappings (GET /referrer-mappings?account_id=...), optionally including inactive ones
  • Create, update, and delete mappings
  • Deactivate a mapping (is_active: false) without deleting it

See the Referrer Mappings API reference for every endpoint and example. Creating or modifying mappings requires editor-or-higher (write) permissions.


Match Types

The Match Type controls how the referrer domain of an incoming visit is compared against your pattern:

Match typeBehavior
ExactMatches the domain exactly
ContainsThe domain contains the pattern
Starts withThe domain starts with the pattern
Ends withThe domain ends with the pattern
RegexThe domain matches a regular expression

The referrer pattern is normalized when saved: the protocol (http://, https://) and any path are stripped, and the value is lowercased. Enter just the domain.


Fields Reference

A referrer mapping stores the following fields:

FieldRequiredDefaultNotes
referrer_patternYesDomain pattern to match (max 255 chars)
match_typeNoexactOne of exact, contains, starts_with, ends_with, regex
utm_sourceYesSource to apply
utm_mediumNoreferralMedium to apply
utm_campaignNoemptyCampaign to apply
utm_termNoemptyTerm to apply
utm_contentNoemptyContent to apply
labelNoHuman-readable label
descriptionNoOptional description
priorityNo0Higher priority mappings are checked first (01000)
is_activeNotrueWhether the mapping is applied