Read the referral report

THE CALL, PART BY PART

method

GET

host

strait.link

version

/v1

resource

/referrals

GET /v1/referrals

Auth: secret key as Authorization: Bearer. Server-side only.

Request

For each referral code in [from, to): the taps that carried it and the referred installs (an install that opened and matched a tap with that code, at most one per tap). A tap counts at its tap time, a referred install at its first open; days are UTC. Most conversions first. Secret key only (a publishable key gets 401). At most 92 days per call and 30 calls a minute per workspace (429 with Retry-After). Each new referred install also fires the referral.converted webhook.

Parameters

from string query
Inclusive start: ISO date (2026-10-01, UTC), ISO date-time or epoch ms. Default: 30 days before to.
to string query
Exclusive end, same formats. Default: now.

Response

  • 200 Totals plus one row per referral code
  • 400 Bad from / to (or a range over 92 days)
  • 401 Missing or invalid secret key, or a publishable key
  • 404 Referrals are switched off on this engine (REFERRALS=off)
  • 429 Over 30 calls a minute for this workspace
Request · curl
curl -X GET https://strait.link/v1/referrals \
  -H "Authorization: Bearer $SECRET_KEY"

The response, printed

Response 200
{
  "from": "2026-10-01T00:00:00.000Z",
  "to": "2026-11-01T00:00:00.000Z",
  "timezone": "UTC",
  "totals": {
    "codes": 2,
    "taps": 57,
    "conversions": 14
  },
  "rows": [
    {
      "code": "ASHA42",
      "taps": 41,
      "conversions": 11,
      "lastTapAt": "2026-10-30T18:12:00.000Z",
      "lastConversionAt": "2026-10-30T18:20:00.000Z"
    },
    {
      "code": "RAVI7",
      "taps": 16,
      "conversions": 3,
      "lastTapAt": "2026-10-28T09:41:00.000Z",
      "lastConversionAt": "2026-10-27T11:05:00.000Z"
    }
  ]
}