Skip to main content

​
Deep Links API

Deep-link endpoints attribute app installs or first opens to recent web clicks so the app can route users to the intended destination.

​
Endpoints

  • POST /deep-links/attribute
  • POST /deep-links/attribute-by-hash
  • GET /deep-links/check/:clickId

​
Attribution inputs

POST /deep-links/attribute accepts raw device/browser attributes and computes identity hashes server-side. POST /deep-links/attribute-by-hash accepts precomputed hashes:
  • stableHash
  • semiStableHash (optional)
  • fullHash (optional)
Both support app context fields such as appId, optional deviceId, and optional linkId scoping.

​
Matching model

  • Matching checks hash tiers in order: full -> semi-stable -> stable.
  • Response includes:
    • matched boolean
    • confidence (high, medium, low, none)
    • matchedHash
    • timeDecay
  • When matched, click context is returned (linkId, campaignId, destination URL, UTM/referrer metadata, clickId).

​
Click ID lookup flow

Use GET /deep-links/check/:clickId for install-referrer style flows where click ID is already available in the app. Response returns:
  • found: true/false
  • click context when found

​
Operational notes

  • Attribution is best-effort and depends on recent click cache availability.
  • These endpoints are designed for SDK/app-server integration paths rather than dashboard UI calls.
  • Use HTTPS and avoid sending raw high-entropy client fingerprints unless required by your privacy policy.
Related docs:
  • /user-guides/manual/growth/deep-links-and-qr-reference
  • /user-guides/manual/workspace/workspace-settings-and-governance-reference