Report that a link opened the app

THE CALL, PART BY PART

method

POST

host

strait.link

version

/v1

resource

/open

POST /v1/open

Auth: publishable key as publishableKey in the JSON body. Safe in apps and websites.

Request

Sent by the Strait SDKs for every link open they cannot report through /v1/resolve, /v1/referrer or /v1/match (browser hand-offs, your own https links), and to retry any open report that failed to send. De-duplicated by openId.

Body (JSON)

publishableKey required string
openId required string
kind required "direct" | "deferred"
route required "app_link" | "custom_scheme" | "install_referrer" | "fingerprint"
appState "closed" | "background" | "foreground"
platform required string
url string
The opened URL (only host + path are stored)
clickId string
The tap id from strait_click
linkId string
matched boolean
reason string
firstLaunch boolean
at number
When it opened (epoch ms)
deviceClass "phone" | "tablet"
What the app runs on (iPad = tablet), stored on the tap this open records. iPadOS Safari sends a Mac user agent, so browser taps from an iPad count as desktop.
appVersion string
The app's own version (iOS CFBundleShortVersionString, Android versionName), kept on the open. 1-64 printable ASCII characters; anything else is ignored, never an error.
sdkVersion string
The Strait SDK version, kept on the open. Same rule as appVersion.

Response

  • 202 Recorded (duplicate: true when this openId was already recorded)
  • 400 Invalid fields
  • 401 Missing or invalid key
  • 429 Rate limited: per IP (60 burst, 1 a second) or per workspace (600 burst, 10 a second; Retry-After). The SDKs keep the report and retry it, de-duplicated by openId
Request · curl
curl -X POST https://strait.link/v1/open \
  -H "Content-Type: application/json" \
  -d '{
    "publishableKey": "st_pub_live_…",
    "openId": "o_lx3k2a_9f8e7d6c5b4a",
    "kind": "direct",
    "route": "custom_scheme",
    "appState": "background",
    "platform": "android",
    "url": "hilltop://sale/summer",
    "clickId": "9a1c7e52-4b3d-4f8e-a6d1-0c2b5e7f9a34",
    "linkId": "lnk_5f0c2a8e-3b1d-4f6a-9c7e-2d8b1a0e4f63",
    "matched": true,
    "at": 1790000000000
  }'

The response, printed

Response 202
{
  "ok": true,
  "duplicate": false
}