Track a deep link open event

This endpoint is used to track when a user opens your app via a Dub-powered deep link (for both iOS and Android).

1 min read

post/track/open

Request example

curl --request POST \
  --url https://api.dub.co/track/open \
  --header 'Content-Type: application/json' \
  --data '{
  "deepLink": "<string>",
  "dubDomain": "<string>"
}'

Response

{
  "clickId": "<string>",
  "link": {
    "id": "link_xxx",
    "domain": "acme.link",
    "key": "fb-promo",
    "url": "https://acme.com/product/123"
  }
}

post/track/open

Note

Deferred deep linking requires a Pro plan subscription or higher.

Body

application/json

deepLinkstring#

The deep link that brought the user to the app. If left blank, Dub will fallback to probabilistic tracking by using the dubDomain parameter to check if there is an associated click event for the user's IP address. Learn more: https://d.to/ddl

Length: max 32000

dubDomainstring#

Your deep link custom domain on Dub (e.g. acme.link). This is used in probabilistic tracking to check if there is an associated click event for the user's IP address. Learn more: https://d.to/ddl

Responses

application/json

The response from the tracked open event.

clickIdstringrequired#

The click ID of the associated open event (or the prior click that led the user to the app store for probabilistic tracking). Learn more: https://d.to/ddl

linkobjectrequired#

The deep link that brought the user to the app. This will be null if the open event was not associated with a link (e.g. a direct download from the app store). Learn more: https://d.to/ddl

Show child attributes

idstringrequired#

The ID of the deep link.

domainstringrequired#

The domain of the deep link.

keystringrequired#

The key of the deep link.

urlstringrequired#

The URL of the deep link.

Track a sale event Retrieve customer