POST
/
track
/
open
Track a deep link open event
curl --request POST \
  --url https://api.dub.co/track/open \
  --header 'Content-Type: application/json' \
  --data '{
  "deepLink": "<string>",
  "dubDomain": "<string>"
}'
{
  "clickId": "<string>",
  "link": {
    "id": "link_xxx",
    "domain": "acme.link",
    "key": "fb-promo",
    "url": "https://acme.com/product/123"
  }
}

Body

application/json
​
deepLink
string

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

​
dubDomain
string

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

Response

The response from the tracked open event.

​
clickId
string | null
required

The click ID of the associated open event (or the prior click that led the user to the app store for probabilistic tracking). 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

​
link
object | null
required

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